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 nameDescriptionRequiredLengthData type
ssl_merchant_idMerchant ID
Elavon-assigned Converge Account ID (AID).
Required6 or 7numeric
ssl_user_idConverge User ID
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Required15alphanumeric
ssl_pinTerminal 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.
Required64alphanumeric
ssl_transaction_typeTransaction Type
Valid value:  BITXNQUERY
Required20alphanumeric
ssl_dateTransaction Date
The date at which the batch was imported.
Required10alphanumeric
ssl_file_nameName of the batch file
Important:
  • Valid file extensions are CSV and XML.
Required255alphanumeric
ssl_resultTransaction result
Valid Values:
  • A- Approved transactions
  • D- Declined transactions and errors
  • Any value other than A and D returns all transactions
Optional1alpha

Response

Field nameDescription
summary
ssl_file_nameFile name
Important:
  • Valid file extensions are CSV and XML.
ssl_statusTransaction Result Message
Refer to the Transaction Settlement Response Codes section for an extensive list of possible returned messages.
Valid Values:
  • C- Complete transactions
  • E- Error transactions
ssl_user_idConverge User ID
The ID of the user who had submitted the batch import.
ssl_file_typeType of the imported batch file
Important:  
  • Recurring batch import creates templates for future recurring transactions
  • Token batch import accepts a file of card numbers and returns tokens
  • Card Transactions batch import
ssl_start_dateStart date of the batch import
Format: YYYY-MM-DD hh:mm:ss
Example: 2022-06-13 14:58:45.0
ssl_end_dateEnd date of the batch import
Format: YYYY-MM-DD hh:mm:ss
Example: 2022-06-13 14:58:45.0
ssl_totalTotal number of transactions in the batch
ssl_approvedNumber of Approved transactions
ssl_failedNumber of Failed/Declined transactions
transactions
ssl_cardMasked Card Number
ssl_recurring_idRecurring ID
Unique Identifier of the recurring transaction
Valid Value: recurring id
ssl_exp_dateCard’s Expiry Date
Returned based on merchant setup
Format: MMYY
ssl_avsAddress Verification Response Code
Refer to the AVS Response Codes section for a complete list of AVS response codes.
ssl_card_typeShort Description for card type
Valid value: MC, VISA, DC, AMEX, etc.
ssl_tokenCard Token
Encrypted card data that can replace ssl_card_number.
ssl_resultTransaction Outcome
An ssl_result = 0 indicates an imported batch file.
An ssl_result = 1 indicates an unsuccessful batch file import.
ssl_messageError name if there was an error.
ssl_error_codeError 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>