Transaction Query - txnquery

This section describes the message parameters for End of Day Transaction Query processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The txnquery transaction searches for a transaction based on a date range, card data, or combination of both.

In this section:

For the entire list of API endpoints, refer to API Endpoints.

Request

note

Search only allows the use of a single card information, a date range or a single card information and date range. Search does not allow multiple card information data on a single request.

Field name	Description	Required	Length	Data type
`ssl_merchant_id`	Merchant ID Elavon-assigned Converge Account ID (AID).	Required	6 or 7	numeric
`ssl_user_id`	Converge User ID The user ID with Hosted Payment API User status that can send transaction requests through the terminal.	Required	15	alphanumeric
`ssl_pin`	Terminal ID Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway. Important: The `ssl_user_id` sending the transaction request must be associated with the terminal that will process the request.	Required	64	alphanumeric
`ssl_merchant_txn_id`	Merchant Transaction ID Unique transaction reference number sent to the downstream systems as part of the Encompass ROC data.	Optional	39	alphanumeric
`ssl_settlement_batch_response`	Main ID It can used to query a group of settled transactions from server by passing the GBOK number. Example: GBOK 32910121808	Optional	30	alphanumeric
`ssl_transaction_type`	Transaction Type Valid Value: `txnquery`	Required	20	alphanumeric
`ssl_recurring_id`	Recurring ID Unique Identifier of the recurring transaction Important: If you use this identifier with `ssl_search_start_date` and `ssl_search_end_date`, then date range of one year is allowed. Valid Value: `recurring id`	Optional	46	alphanumeric
`ssl_time_zone_request_utc`	Time zone in Coordinated Universal Time (UTC) Format: MM/DD/YYYY hh:mm:ss Example: 12/28/2021 10:34:10 `Y` - Convert any provided timestamps into UTC format `N` - Does not convert the timestamps into UTC Important:`ssl_time_zone_request_utc` works completely independent of `ssl_time_zone_response_utc`.	Conditional	20	alphanumeric
`ssl_time_zone_response_utc`	Time zone in Coordinated Universal Time (UTC) Format: MM/DD/YYYY hh:mm:ss Example: 12/28/2021 10:34:10 `Y` - Display the time zone in UTC `N` - Does not display the time zone in UTC If Y is selected, then `ssl_txn_time_utc`, `ssl_settle_time_utc`, `ssl_service_fee_txn_time_utc`, `ssl_search_start_date`, `ssl_search_end_date` will display in UTC format	Conditional	20	alphanumeric
[Transaction ID]	Important: This parameter cannot be used with the Card Data and Date Range parameters.
`ssl_txn_id`	Transaction ID Unique identifier of the original transaction.	Conditional	46	alphanumeric
[Additional Search Filter]
`ssl_include_signature`	Include Signature Indicator Indicates whether to include transactions with signature images to the transaction query results. Valid Values: `TRUE` - Include transactions with signature images `FALSE` - Exclude transactions with signature images	Optional	-	alphanumeric
[Card Data]	Use the appropriate card data parameter for the transaction. Important: One of these parameters can be used as the search criteria or used with the Date Range parameters.
`ssl_card_number`	Card Number Card Number as it appears on the credit card.	Conditional	18	numeric
`ssl_track_data`	Raw Track I and/or II Data Track data captured from the card’s magnetic stripe. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first name and last name.	Conditional	76	alphanumeric
`ssl_card_suffix`	Last 4 Digits	Conditional	4	numeric
[Date Range]	Important: These parameters can be used as the search criteria or used with one of the Card Data parameters.
[Additional Search Filters]	Important: These parameters can only be used with the Card Data and Date Range parameters.
`ssl_search_description`	Search Filter - Merchant-defined Transaction Description Retrieve transactions based on the merchant’s custom transaction description.	Optional	255	alphanumeric
`ssl_search_first_name`	Search Filter - First Name Retrieve transactions based on the first names sent in the original transactions.	Optional	50	alphanumeric
`ssl_search_last_name`	Search Filter - Last Name Retrieve transactions based on the last names sent in the original transactions.	Optional	50	alphanumeric
`ssl_search_transaction_type`	Search Filter - Transaction Type Retrieve transactions based on transaction types.	Optional	20	alphanumeric
`ssl_search_start_date`	Search Filter - Start Date Start date for the transaction date range. If you submit a start date without an end date, Converge sets the value of `ssl_search_end_date` to `ssl_search_start_date` plus 31 days. Default: End date - 31 days Format: MM/DD/YYYY	Conditional	10	alphanumeric
`ssl_search_end_date`	Search Filter - End Date End date for the transaction date range. If you submit an end date without a start date, Converge sets the value of `ssl_search_start_date` to `ssl_search_end_date` minus 31 days. Default: Start date + 31 days Format: MM/DD/YYYY	Optional	10	alphanumeric
`ssl_search_min_amount`	Search Filter - Minimum Amount Minimum value for the transaction amount range. Values must be equal to or less than `ssl_search_max_amount`.	Optional	11	numeric
`ssl_search_max_amount`	Search Filter - Maximum Amount Maximum value for the transaction amount range. Values must be greater than `ssl_search_min_amount`.	Optional	11	numeric
`ssl_search_card_type`	Search Filter - Payment Type Retrieve transactions based on payment types. Valid Values: `CASH` `CREDITCARD` `DEBITCARD` `FOODSTAMP` `GIFTCARD`	Optional	10	alphanumeric
`ssl_search_card_short_description`	Search Filter - Card Short Description Retrieve transactions based on card brands. Valid Values: `AMEX` - American Express `CUP` - China Union Pay `DISC` - Discover `MC` - MasterCard `PP` - PayPal `VISA` - Visa	Optional	-	alphanumeric
`ssl_search_taxed`	Search Filter - Taxed Transaction Retrieve transactions based on sales taxes. Valid Values: `T` - Search transactions with sales taxes `F` - Search transactions without sales taxes	Optional	1	alphanumeric
`ssl_search_tipped`	Search Filter - Tipped Transaction Retrieve transactions based on tip amounts. Valid Values: `T` - Search transactions with tip amounts `F` - Search transactions without tip amounts	Optional	1	alphanumeric

Response

note

Converge lists the query result in descending date/time order.
When the query is based on Transaction ID, the query result contains one single unique transaction or lists all the product line items for Level 3 transactions.
When the query is based on a Card Data parameter, Converge retrieves transactions from the Open and Settled batches that are within the last two months.
When the query is based on Card Data and Date Range parameters, Converge retrieves transactions from the Open and Settled batches that match the specified date range.
When the query returns more than a single transaction, the detailed response of each transaction will contain the original response along with the Transaction Status (ssl_trans_status).

Field name	Description
`ssl_user_id`	Converge User ID The user ID that submitted the query request. Field length: 15 Data type: alphanumeric
`ssl_result_message`	Transaction Result Message Refer to the Transaction Query Response Codes section for an extensive list of possible returned messages.
`ssl_txn_id`	Transaction ID Unique identifier of the transaction.
`ssl_txn_time`	Processing Date and Time Indicates when Converge processed the transaction. Format: MM/DD/YYYY hh:mm:ss AM/PM Example: 03/18/2010 10:34:10 AM
`ssl_txn_time_utc`	Processing Date and Time in UTC format Indicates when Converge processed the transaction. Format: MM/DD/YYYY hh:mm:ss
`ssl_approval_code`	Transaction Approval Code Unique code returned that indicates the approval status of the transaction.
`ssl_txn_count`	Transaction Count Number of transactions matching the search criteria. Important: - Returned when the query is based on Card Data and/or Date Range. - The result can only show a maximum of 1000 unique transactions at one time. - If there are more than 1000 records in a batch, Converge will return the first 1000 records.
`ssl_next_txn_time`	Transaction Timestamp Timestamp of the transaction in the next set when the `ssl_txn_count` in the batch exceeds 1000. Important: Returned when the query is based on Card Data and/or Date Range. The point-of-sale application can use this timestamp to request the next set of 1000 transactions. Use the next txn time and query for the next 1000 records until all records in the settled batches are retrieved.
`ssl_trans_status`	Transaction Status Valid Values: `PEN` - Pended `OPN` - Unpended / Release / Open `REV` - Review `STL` - Settled `PST` - Failed Due to Post-Auth Rule `FPR` - Failed Due to Fraud Prevention Rules `PRE` - Failed Due to Pre-Auth Rule
`ssl_card_type`	Card Type Payment method used for the transaction. Valid Values: `CREDITCARD` `DEBITCARD` `FOODSTAMP` `CASHBENEFIT` `ELECTRONICCHECK` `GIFTCARD` `CASH`
`ssl_service_fee_txn_time_utc`	Service Fee Processing Date and Time in UTC format Indicates when Converge processed the service fee transaction. Format: MM/DD/YYYY hh:mm:ss
`ssl_settle_time_utc`	Settling Date and Time in UTC format Indicates when Converge settled the transaction. Format: MM/DD/YYYY hh:mm:ss
`ssl_settlement_batch_response`	Main ID It can used to query a group of settled transactions from server by passing the GBOK number. Example: GBOK 32910121808
`ssl_transaction_type`	Transaction Type
`ssl_card_number`	Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
`ssl_entry_mode`	Transaction Entry Indicator Indicates how the track data was captured. Field length: 2 Data type: numeric Valid Values: `K` - Hand-Keyed `S` - Swiped
`ssl_avs_response`	Address Verification Response Code Refer to the AVS Response Codes section for a complete list of AVS response codes.
`ssl_cvv2_response`	Card Verification Response Code Refer to the CVV2/CVC2 Response Codes section for a complete list of CVV/CVC2 response codes.
`ssl_amount`	Total Authorized/Approved Transaction Amount Returned based on merchant setup.
`ssl_invoice_number`	Invoice Number The invoice number or ticket number sent in the original request. Returned based on merchant setup.
`ssl_exp_date`	Card’s Expiry Date Returned based on merchant setup.
`ssl_recurring_batch_count`	Recurring Batch Count The current number of transactions sitting in the recurring batch after the recurring transaction has been added.
`ssl_response_advicecode`	Merchant Advice Code (MAC) response for MasterCard Transactions Valid Values: `M03` - Do not try again (MasterCard) `M21`- Payment Cancellation (MasterCard)
`ssl_salestax`	Sales Tax This field is Optional Field length: 8 Data type: alphanumeric
`ssl_description`	Merchant-defined Transaction Description Short and custom text to describe the transaction.
`ssl_service_fee`	Service Fee The service fee applied and / or refunded.
`ssl_lane_number`	Lane Number
[Card Data/Date Range]	Returned when query is based on Card Data and/or Date Range parameters.
`ssl_card_short_description`	Short Card Brand Name
`ssl_tip_amount`	Tip Amount
[Transaction ID]	Returned when query is based on Transaction ID parameters.
`ssl_avs_address`	Address Line 1 Commonly the house number and street name on the cardholder’s / customer’s account or billing address. Returned based on merchant setup.
`ssl_address2`	Address Line 2 Apartment or condominium unit number and floor number on the cardholder’s or customer’s account or billing address.
`ssl_address3`	Address Line 3
`ssl_company`	Company Name Company name on the cardholder’s / customer’s account or billing address.
`ssl_city`	City name on the cardholder’s / customer’s account or billing address.
`ssl_state`	State Code State or province code on the cardholder’s / customer’s account or billing address.
`ssl_avs_zip`	Postal or ZIP Code Postal or ZIP code on the cardholder’s or customer’s account or billing address.
`ssl_country`	Country ISO Code Country ISO code on the cardholder’s / customer’s account or billing address.
`ssl_cardholder_currency`	Cardholder Currency
`ssl_terminal_currency`	Terminal Currency
`ssl_cardholder_amount`	Cardholder Amount Total amount in the cardholder’s billing currency.
`ssl_tip_amount`	Tip Amount
`ssl_cardholder_tip_amount`	Tip Amount Tip amount in the cardholder’s currency.
`ssl_is_voidable`	Void Indicator
`ssl_account_balance`	Account Balance Available balance on the card.
`ssl_departure_Date`	Travel Departure Date
`ssl_completion_Date`	Travel Completion Date
`ssl_ship_to_first_name`	Recipient’s First Name
`ssl_ship_to_last_name`	Recipient’s Last Name
`ssl_ship_to_company`	Recipient’s Company Name
`ssl_ship_to_address1`	Recipient’s Address Line 1
`ssl_ship_to_address2`	Recipient’s Address Line 2
`ssl_ship_to_address3`	Recipient’s Address Line 3
`ssl_ship_to_city`	Recipient’s City
`ssl_ship_to_state`	Recipient’s State Code
`ssl_ship_to_zip`	Recipient’s Postal or ZIP Code
`ssl_ship_to_country`	Recipient’s Country ISO Code
`ssl_signature_image`	Signature Image Digital version of the cardholder’s signature.
`ssl_image_type`	Signature Image Format File format of the signature image. Valid Values: `GIF` `TIF` `JPG` `PNG`
`ssl_line_item_description`	Line Item Description
`ssl_line_Item_product_code`	Line Item Product Code The part or catalog number of the line item.
`ssl_line_Item_commodity_code`	Line Item Commodity Code The commodity code used to classify the line item.
`ssl_line_Item_quantity`	Line Item Quantity The number of purchased units for the line item.
`ssl_line_Item_unit_of_measure`	Line Item Measurement Code The unit of measure that each line item is purchased in.
`ssl_line_Item_unit_cost`	Line Item Unit Cost The cost of each purchased unit for the line item.
`ssl_line_Item_discount_indicator`	Line Item Discount Indicator Indicates whether the line item is discounted. Valid values: `Y` - Item amount is discounted `N` - Item amount is not discounted
`ssl_line_Item_tax_indicator`	Line Item Tax Indicator Indicates whether the line item is taxable. Valid values: `Y` - Item amount is taxable `N` - Item amount is not taxable
`ssl_line_item_discount_amount`	Discount Amount The discount amount for the entire line item.
`ssl_line_Item_tax_rate`	Line Item Tax Rate
`ssl_line_Item_tax_amount`	Line Item Tax Amount The tax amount for each purchased unit.
`ssl_line_Item_tax_type`	Line Item Tax Type The type of tax applied to the line item.
`ssl_line_Item_extended_total`	Line Item Extended Amount The total cost of the line item for the detail record. Computation Rule: Quantity x Unit Price
`ssl_line_Item_total`	Line Item Total Amount
[Error]	Returned only if an error occurs. Refer to the Error Codes section for more information.
`errorCode`	Error Code Typically, when the transaction failed validation or the request is incorrect. This will prevent the transaction from going to authorization. This is a numeric field.
`errorMessage`	Error Message Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
`errorName`	Error Name Error name or reason for the error.

Examples

important

In these examples, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

Transaction ID

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_txn_id>AA786F-4CEC21A7-B70A-4584-AC8C-5040C0297354</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_txn_id>AA786F-4CEC21A7-B70A-4584-AC8C-5040C0297354</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>STL</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>CCSALE</ssl_transaction_type>
    <ssl_txn_time>12/18/2013 09:13:24 AM</ssl_txn_time>
    <ssl_first_name>George P.</ssl_first_name>
    <ssl_last_name>Burdell</ssl_last_name>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_exp_date>1216</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_avs_response />
    <ssl_cvv2_response />
    <ssl_amount>5.00</ssl_amount>
    <ssl_invoice_number />
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>N29032</ssl_approval_code>
</txn>

Date Range

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_search_start_date>04/30/2015 09:34:36 AM</ssl_search_start_date>
    <ssl_search_end_date>020/30/2015 09:34:36 PM</ssl_search_end_date>
</txn>

Recurring id

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_recurring_id>160720MB-0597EDEE-E1E9-4786-A36B-12DF8E8BEFC6</ssl_recurring_id>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_search_start_date>06/09/2022</ssl_search_start_date>
    <ssl_search_end_date>02/27/2023</ssl_search_end_date>
</txn>

Card Number

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_pin</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_card_number>[Full Card Number]</ssl_card_number>
</txn>

Response

<txnlist>
    <ssl_txn_count>2</ssl_txn_count>
    <txn>
        <ssl_txn_id>AA786F-4CEC21A7-B70A-4584-AC8C-5040C0297354</ssl_txn_id>
        <ssl_user_id>my_user_id</ssl_user_id>
        <ssl_trans_status>STL</ssl_trans_status>
        <ssl_card_type>CREDITCARD</ssl_card_type>
        <ssl_transaction_type>CCSALE</ssl_transaction_type>
        <ssl_txn_time>12/18/2013 09:13:24 AM</ssl_txn_time>
        <ssl_first_name>George P.</ssl_first_name>
        <ssl_last_name>Burdell</ssl_last_name>
        <ssl_card_number>00**********0000</ssl_card_number>
        <ssl_exp_date>1216</ssl_exp_date>
        <ssl_entry_mode>K</ssl_entry_mode>
        <ssl_avs_response />
        <ssl_cvv2_response />
        <ssl_amount>5.00</ssl_amount>
        <ssl_invoice_number />
        <ssl_result_message>APPROVAL</ssl_result_message>
        <ssl_approval_code>N29032</ssl_approval_code>
    </txn>
    <txn>
        <ssl_txn_id>AA786F-4CEC21A7-B70A-4584-AC8C-5040C0297354</ssl_txn_id>
        <ssl_user_id>my_user_id</ssl_user_id>
        <ssl_trans_status>STL</ssl_trans_status>
        <ssl_card_type>CREDITCARD</ssl_card_type>
        <ssl_transaction_type>CCSALE</ssl_transaction_type>
        <ssl_txn_time>12/18/2013 09:13:24 AM</ssl_txn_time>
        <ssl_first_name>George P.</ssl_first_name>
        <ssl_last_name>Burdell</ssl_last_name>
        <ssl_card_number>00**********0000</ssl_card_number>
        <ssl_exp_date>1216</ssl_exp_date>
        <ssl_entry_mode>K</ssl_entry_mode>
        <ssl_avs_response />
        <ssl_cvv2_response />
        <ssl_amount>5.00</ssl_amount>
        <ssl_invoice_number />
        <ssl_result_message>APPROVAL</ssl_result_message>
        <ssl_approval_code>N29032</ssl_approval_code>
    </txn>
<txnlist>

Track Data

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_track_data>[Track Data]</ssl_track_data>
</txn>

Last 4 Digits of a Card Number

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_card_suffix>3003</ssl_card_suffix>
</txn>

Line Item

Request

xmldata=
<txn>
    <ssl_merchant_ID>my_merchant_id</ssl_merchant_ID>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_txn_id>061118MB-1CEEFA33-03E3-4439-A2CE-6118F519390E</ssl_txn_id>
</txn>

Response

<txn>
    <ssl_txn_id>061118MB-1CEEFA33-03E3-4439-A2CE-6118F519390E</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>OPN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>CCSALE</ssl_transaction_type>
    <ssl_txn_time>11/06/2018 02:33:39 PM</ssl_txn_time>
    <ssl_card_number>40**********0002</ssl_card_number>
    <ssl_exp_date>1221</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_amount>5.00</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>902740</ssl_approval_code>
    <ssl_transaction_language>en</ssl_transaction_language>
    <ssl_cardholder_currency>CAD</ssl_cardholder_currency>
    <ssl_terminal_currency>CAD</ssl_terminal_currency>
    <ssl_is_voidable>TRUE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
    <lineItemProducts>
    <product>
        <ssl_line_Item_description>Product-169</ssl_line_Item_description>
        <ssl_line_Item_product_code>PRO-169</ssl_line_Item_product_code>
        <ssl_line_Item_commodity_code>10000169</ssl_line_Item_commodity_code>
        <ssl_line_Item_quantity>1</ssl_line_Item_quantity>
        <ssl_line_Item_unit_of_measure>EC</ssl_line_Item_unit_of_measure>
        <ssl_line_Item_unit_cost>5.00</ssl_line_Item_unit_cost>
        <ssl_line_Item_discount_indicator>N</ssl_line_Item_discount_indicator>
        <ssl_line_Item_discount_amount>0.00</ssl_line_Item_discount_amount>
        <ssl_line_Item_tax_Indicator/>
        <ssl_line_Item_tax_rate/>
        <ssl_line_Item_tax_amount/>
        <ssl_line_Item_tax_type/>
        <ssl_line_Item_extended_total>5.00</ssl_line_Item_extended_total>
        <ssl_line_Item_total>5.00</ssl_line_Item_total>
    </product>
    </lineItemProducts>
</txn>

Use GBOK

Request

xmldata=
<txn>
    <ssl_merchant_id>000006</ssl_merchant_id>
    <ssl_user_id>user</ssl_user_id>
    <ssl_pin>W5E5G</ssl_pin>
    <ssl_transaction_type>TXNQUERY</ssl_transaction_type>
    <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
</txn>

Response

<txnlist>
    <ssl_txn_count>2</ssl_txn_count>
    <txn>
        <ssl_txn_id>280921M32-51E2AF14-3619-4FF2-A7AC-CD4928F5F7AE</ssl_txn_id>
        <ssl_user_id>cactus</ssl_user_id>
        <ssl_trans_status>STL</ssl_trans_status>
        <ssl_settle_time>09/28/2021 02:59:09 PM</ssl_settle_time>
        <ssl_card_type>CREDITCARD</ssl_card_type>
        <ssl_card_short_description>VISA</ssl_card_short_description>
        <ssl_transaction_type>SALE</ssl_transaction_type>
        <ssl_txn_time>09/28/2021 02:57:10 PM</ssl_txn_time>
        <ssl_card_number>40**********0002</ssl_card_number>
        <ssl_exp_date>1222</ssl_exp_date>
        <ssl_entry_mode>K</ssl_entry_mode>
        <ssl_cvv2_response>M</ssl_cvv2_response>
        <ssl_amount>1.00</ssl_amount>
        <ssl_result_message>APPROVAL</ssl_result_message>
        <ssl_approval_code>200909</ssl_approval_code>
        <ssl_refunded_amount>0.0</ssl_refunded_amount>
        <ssl_transaction_language>EN</ssl_transaction_language>
        <ssl_eci_ind>3</ssl_eci_ind>
        <ssl_ps2000_data>A7512716823024265045VE</ssl_ps2000_data>
        <ssl_oar_data>010012856109281857100000047554200000000000200909127118128561</ssl_oar_data>
        <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
    </txn>
    <txn>
        <ssl_txn_id>280921M32-DB2F346A-3849-41D1-80B0-C3EA7249EEE9</ssl_txn_id>
        <ssl_user_id>cactus</ssl_user_id>
        <ssl_trans_status>STL</ssl_trans_status>
        <ssl_settle_time>09/28/2021 02:59:09 PM</ssl_settle_time>
        <ssl_card_type>CREDITCARD</ssl_card_type>
        <ssl_card_short_description>VISA</ssl_card_short_description>
        <ssl_transaction_type>SALE</ssl_transaction_type>
        <ssl_txn_time>09/28/2021 02:57:05 PM</ssl_txn_time>
        <ssl_card_number>40**********0002</ssl_card_number>
        <ssl_exp_date>1222</ssl_exp_date>
        <ssl_entry_mode>K</ssl_entry_mode>
        <ssl_cvv2_response>M</ssl_cvv2_response>
        <ssl_amount>1.00</ssl_amount>
        <ssl_result_message>APPROVAL</ssl_result_message>
        <ssl_approval_code>200903</ssl_approval_code>
        <ssl_refunded_amount>0.0</ssl_refunded_amount>
        <ssl_transaction_language>EN</ssl_transaction_language>
        <ssl_eci_ind>3</ssl_eci_ind>
        <ssl_ps2000_data>A7512716822524245045VE</ssl_ps2000_data>
        <ssl_oar_data>010012855609281857050000047554200000000000200903127118128556</ssl_oar_data>
        <ssl_settlement_batch_response>GBOK 36909281459</ssl_settlement_batch_response>
    </txn>
</txnlist>

Settlement

Request

xmldata=
<txn>
    <ssl_merchant_ID>my_merchant_id</ssl_merchant_ID>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>STLQUERY</ssl_transaction_type>
</txn>

Response

<txn>
    <ssl_result>0</ssl_result>
    <batch>202</batch>
    <response>GBOK 20205041108</response>
    <settleddate>05/04/2021 11:05:15</settleddate>
    <main>
        <netcount>10001</netcount>
        <baseamount>0.00</baseamount>
        <tipamount>0.00</tipamount>
        <netamount>45010.00</netamount>
        <numberpurchaseforces>10001</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </main>
    <gift>
        <netcount>0</netcount>
        <baseamount/>
        <tipamount/>
        <netamount/>
        <numberpurchaseforces>0</numberpurchaseforces>
        <numberreturns>0</numberreturns>
        <numbervoids>0</numbervoids>
    </gift>
  </txn>

Transaction Status (OPN)

note

OPN is used in this example. You can insert any of the other statuses (PEN, REV, STL, PST, FPR, PRE) in ssl_trans_status as necessary.

<txn>
    <ssl_txn_id>170521E3A-56520AAA-940B-491D-BE70-FCACEB7AEE09</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>OPN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_txn_time>05/17/2021 12:43:40 PM</ssl_txn_time>
    <ssl_card_number>40**********0606</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_amount>10.00</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>861725</ssl_approval_code>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_cvm_signature_override_result>optional</ssl_cvm_signature_override_result>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>TRUE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_ship_to_address1>7300 Chapman Hwy</ssl_ship_to_address1>
    <ssl_ship_to_address2>Unit 700</ssl_ship_to_address2>
    <ssl_ship_to_first_name>peter</ssl_ship_to_first_name>
    <ssl_ship_to_last_name>lee</ssl_ship_to_last_name>  
    <ssl_ship_to_city>Knoxville</ssl_ship_to_city>
    <ssl_ship_to_country>USA</ssl_ship_to_country>
    <ssl_ship_to_state>TN</ssl_ship_to_state>
    <ssl_ship_to_zip>37920</ssl_ship_to_zip>
</txn>

Response-only queries

Device Info

<txn>
    <ssl_txn_id>170521M33-A146637D-367A-4091-BCB8-6F861C273D3E</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>PEN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_txn_time>05/17/2021 03:34:34 PM</ssl_txn_time>
    <ssl_first_name>TEST</ssl_first_name>
    <ssl_last_name>CARD 01</ssl_last_name>
    <ssl_card_number>47**********0010</ssl_card_number>
    <ssl_exp_date>1215</ssl_exp_date>
    <ssl_entry_mode>C</ssl_entry_mode>
    <ssl_amount>17.37</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>865725</ssl_approval_code>
    <ssl_icc_cvmr>1E0300</ssl_icc_cvmr>
    <ssl_icc_aid>A0000000031010</ssl_icc_aid>
    <ssl_icc_iad>06010A03A00000</ssl_icc_iad>
    <ssl_icc_tvr>0200008000</ssl_icc_tvr>
    <ssl_icc_tsi>E800</ssl_icc_tsi>
    <ssl_icc_app_name>Visa Credit</ssl_icc_app_name>
    <ssl_device_name>IPP320</ssl_device_name>
    <ssl_device_model>IPP320</ssl_device_model>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_credit_surcharge_amount>0.37</ssl_credit_surcharge_amount>
    <ssl_amount_subtotal>17.00</ssl_amount_subtotal>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>TRUE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
</txn>

Service Fee

<txn>
    <ssl_txn_id>170521A41-A83552C8-C69F-442C-B60F-4DC6AFFAEB7D</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>OPN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>RETURN</ssl_transaction_type>
    <ssl_txn_time>05/17/2021 11:41:30 AM</ssl_txn_time>
    <ssl_card_number>40**********0606</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_amount>5.00</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>860561</ssl_approval_code>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_service_fee_txn_id>170521A41-C394FBAB-3910-458B-BDD7-52D4C1223E8F</ssl_service_fee_txn_id>
    <ssl_service_fee_amount>0.50</ssl_service_fee_amount>
    <ssl_service_fee_approval_code>860562</ssl_service_fee_approval_code>
    <ssl_service_fee_txn_time>05/17/2021 11:41:31 AM</ssl_service_fee_txn_time>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>FALSE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
</txn>

Service Fee Return

<txn>
    <ssl_txn_id>170521A40-78B7B6A8-3333-407C-9BEF-750CAE4E0735</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>OPN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_txn_time>05/17/2021 11:17:55 AM</ssl_txn_time>
    <ssl_card_number>40**********0606</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_amount>5.00</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>860276</ssl_approval_code>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_service_fee_txn_id>170521A40-320D8AB5-437A-4F4C-94C8-3DF796245DEB</ssl_service_fee_txn_id>
    <ssl_service_fee_amount>0.50</ssl_service_fee_amount>
    <ssl_service_fee_approval_code>860274</ssl_service_fee_approval_code>
    <ssl_service_fee_txn_time>05/17/2021 11:17:50 AM</ssl_service_fee_txn_time>
    <ssl_service_fee_total_return>0.0</ssl_service_fee_total_return>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>TRUE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
</txn>

Lane Number

<txn>
    <ssl_txn_id>170521A40-174BB762-136E-4FBE-B740-C5DD87E1C707</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>OPN</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_txn_time>05/17/2021 11:48:32 AM</ssl_txn_time>
    <ssl_card_number>40**********0606</ssl_card_number>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_cvv2_response>M</ssl_cvv2_response>
    <ssl_amount>10.00</ssl_amount>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>860646</ssl_approval_code>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_cvm_signature_override_result>optional</ssl_cvm_signature_override_result>
    <ssl_lane_number>654321</ssl_lane_number>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>TRUE</ssl_is_voidable>
    <ssl_account_balance>0.00</ssl_account_balance>
</txn>

Display Time Zone in UTC

Request

xmldata=
<txn>
    <ssl_merchant_ID>my_merchant_id</ssl_merchant_ID>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>TXNQUERY</ssl_transaction_type>
    <ssl_txn_id></ssl_txn_id>
    <ssl_time_zone_response_utc>Y</ssl_time_zone_response_utc>
    <ssl_time_zone_request_utc>Y</ssl_time_zone_request_utc>
    <ssl_search_start_date>01/06/2022 00:00:02</ssl_search_start_date>
    <ssl_search_end_date>01/06/2022 23:59:02</ssl_search_end_date>
</txn>

Mastercard Transaction declined with MAC value M03/M21

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_test_mode>False</ssl_test_mode>
    <ssl_show_form>False</ssl_show_form>
    <ssl_result_format>HTML</ssl_result_format>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_txn_id>160222M1-15B444C0-69F6-4C17-BB34-76DEDC2238C4</ssl_txn_id>
    <ssl_amount>10.08</ssl_amount>
</txn>

Response

<txn>
    <ssl_txn_id>160222M1-15B444C0-69F6-4C17-BB34-76DEDC2238C4</ssl_txn_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>PST</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_card_short_description>MC</ssl_card_short_description>
    <ssl_transaction_type>SALE</ssl_transaction_type>
    <ssl_txn_time>02/16/2022 04:28:55 PM</ssl_txn_time>
    <ssl_card_number>51**********2124</ssl_card_number>
    <ssl_exp_date>1234</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_cvv2_response>U</ssl_cvv2_response>
    <ssl_amount>10.08</ssl_amount>
    <ssl_result_message>Declined - AVS Mismatch</ssl_result_message>
    <ssl_approval_code>QMC297</ssl_approval_code>
    <ssl_refunded_amount>0.0</ssl_refunded_amount>
    <ssl_transaction_language>EN</ssl_transaction_language>
    <ssl_eci_ind>3</ssl_eci_ind>
    <ssl_response_advicecode>M03</ssl_response_advicecode>
    <ssl_cardholder_currency>USD</ssl_cardholder_currency>
    <ssl_terminal_currency>USD</ssl_terminal_currency>
    <ssl_is_voidable>FALSE</ssl_is_voidable>
    <ssl_account_balance>10.08</ssl_account_balance>
    <ssl_ps2000_data>MMCC097C6C 0216E1</ssl_ps2000_data>
    <ssl_oar_data>010001031102162128550216000816800000000000QMC297MCC097C6C</ssl_oar_data>
</txn>

Invoice number

Request

xmldata=
<txn>
    <ssl_merchant_id>my_merchant_id</ssl_merchant_id>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_pin>my_pin</ssl_pin>
    <ssl_transaction_type>txnquery</ssl_transaction_type>
    <ssl_invoice_number>INV7491</ssl_invoice_number>
</txn>

Response

<txn>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_trans_status>STL</ssl_trans_status>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_transaction_type>CCSALE</ssl_transaction_type>
    <ssl_txn_time>12/18/2021 09:13:24 AM</ssl_txn_time>
    <ssl_first_name>George P.</ssl_first_name>
    <ssl_last_name>Burdell</ssl_last_name>
    <ssl_card_number>00**********0000</ssl_card_number>
    <ssl_exp_date>1216</ssl_exp_date>
    <ssl_entry_mode>K</ssl_entry_mode>
    <ssl_avs_response />
    <ssl_cvv2_response />
    <ssl_amount>5.00</ssl_amount>
    <ssl_invoice_number>INV7491</ssl_invoice_number>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_approval_code>N29032</ssl_approval_code>
</txn>