Batch Import Transaction Query - bitxnquery
Converge users who want to see all Accepted and/or Declined transactions from in a file may use a BITXNQUERY request in XML API to request a batch view version of the TXNQUERY.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
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_transaction_type | Transaction Type Valid value: BITXNQUERY | Required | 20 | alphanumeric |
ssl_date | Transaction Date The date at which the batch was imported. | Required | 10 | alphanumeric |
ssl_file_name | Name of the batch file Important:
| Required | 255 | alphanumeric |
ssl_result | Transaction result Valid Values:
| Optional | 1 | alpha |
Response
| Field name | Description |
|---|---|
ssl_file_name | File name Important:
|
ssl_status | Transaction Result Message Refer to the Transaction Settlement Response Codes section for an extensive list of possible returned messages. Valid Values:
|
ssl_user_id | Converge User ID The ID of the user who had submitted the batch import. |
ssl_file_type | Type of the imported batch file Important:
|
ssl_start_date | Start date of the batch import Format: YYYY-MM-DD hh:mm:ss Example: 2022-06-13 14:58:45.0 |
ssl_end_date | End date of the batch import Format: YYYY-MM-DD hh:mm:ss Example: 2022-06-13 14:58:45.0 |
ssl_total | Total number of transactions in the batch |
ssl_approved | Number of Approved transactions |
ssl_failed | Number of Failed/Declined transactions |
| transactions | |
ssl_card | Masked Card Number |
ssl_recurring_id | Recurring ID Unique Identifier of the recurring transaction Valid Value: recurring id |
ssl_exp_date | Card’s Expiry Date Returned based on merchant setup Format: MMYY |
ssl_avs | Address Verification Response Code Refer to the AVS Response Codes section for a complete list of AVS response codes. |
ssl_card_type | Short Description for card type Valid value: MC, VISA, DC, AMEX, etc. |
ssl_token | Card Token Encrypted card data that can replace ssl_card_number. |
ssl_result | Transaction Outcome An ssl_result = 0 indicates an imported batch file.An ssl_result = 1 indicates an unsuccessful batch file import. |
ssl_message | Error name if there was an error. |
ssl_error_code | 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. |
Example
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>BITXNQUERY</ssl_transaction_type>
<ssl_date>11/05/2018</ssl_date>
<ssl_file_name>My_Batch.csv</ssl_file_name>
<ssl_result>A</ssl_result>
</txn>
Response
<batchImport>
<summary>
<ssl_file_name>CCGETTOKEN.csv</ssl_file_name>
<ssl_status>Complete</ssl_status>
<ssl_user_id>my_user_id</ssl_user_id>
<ssl_file_type>CCTOKENIMPORT</ssl_file_type>
<ssl_start_date>2022-06-13 14:58:45.0</ssl_start_date>
<ssl_end_date>2022-06-13 14:59:43.0</ssl_end_date>
<ssl_total>1</ssl_total>
<ssl_approved/>
<ssl_failed>1</ssl_failed>
</summary>
<transactions>
<transaction>
<ssl_card>54**********1172</ssl_card>
<ssl_recurring_id/>
<ssl_exp_date>1227</ssl_exp_date>
<ssl_avs/>
<ssl_card_type>MC</ssl_card_type>
<ssl_token>5584526655241172</ssl_token>
<ssl_result>APPROVAL</ssl_result>
<ssl_message/>
<ssl_error_code/>
</transaction>
<transactions/>
</batchImport>