Batch Billing 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.

Permissions

To use BITXNQUERY, the user whose ssl_user_id is being passed must have Batches - View user right. Take the following steps to grant this user right:

  1. Open the Converge User Interface.
  2. Click the USER tab.
  3. Click Edit User Rights.
  4. Under the Vitual Terminal - Batch, check the box for the Batches - View. image
  5. Save the selected changes.

Required Fields

The following fields are required to successfully process a BITXNQUERY request:

  • <ssl_date>
  • <ssl_file_name>
  • <ssl_transaction_type>
  • <ssl_result>

Request a Batch Billing Query by passing BITXNQUERY through the ssl_transaction_type field.

The contents of the BITXNQUERY are based on the value passed for ssl_result:

  • A shows approved transactions
  • D shows declined transactions and errors
  • An empty field or any other value shows all transactions

Example Batch Import Transaction Query Request

<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>

Example Batch Import Transaction Query Response

<batchImport>
<summary>
    <ssl_file_name>My_Batch.csv</ssl_file_name>
    <ssl_status>Complete</ssl_status>
    <ssl_user_id>my_user_id</ssl_user_id>
    <ssl_file_type>CCRECIMPORT</ssl_file_type>
    <ssl_start_date>2018-11-05 13:30:17.0</ssl_start_date>
    <ssl_end_date>2018-11-05 13:30:32.0</ssl_end_date>
    <ssl_total>3</ssl_total>
    <ssl_approved>2</ssl_approved>
    <ssl_failed>1</ssl_failed>
</summary>
<result>A</result>
<transactions/>
</batchImport>