Inquiry - cbbainquiry

This section describes the message parameters for EBT Card - Cash Benefit Balance Inquiry transaction processing, which you can submit using the XML API integration method. Refer to the Integration Methods section for more information.

The cbbainquiry transaction returns the current available balance of the EBT account.

In this section:


Field name Description Required Length Data type
ssl_merchant_id Merchant ID
Elavon-assigned Converge account ID.
Required 15 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.


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
Value: cbbainquiry
Required 20 alphanumeric
[Card Data]
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 and last name.


Required for swiped or contactless transactions.

Required 76 alphanumeric
[PIN Pad] Values returned by the PIN Pad device.
ssl_dukpt DUKPT
Value used to encrypt the PIN of the cardholder.
Required 20 -
ssl_key_pointer Triple-DES DUKPT Pointer
Indicates the encryption key used on US debit transactions.
Valid value: T - Triple-DES DUKPT
Required 1 alphanumeric
ssl_pin_block Encrypted PIN Block
The encrypted personal identification number entered by the EBT cardholder to authenticate ownership of the card.
Required 16 -


Field name Description
ssl_result Transaction Outcome
An ssl_result = 0 indicates an approved transaction.
An ssl_result not equal to 0 indicates a declined and unauthorized transaction.
ssl_result_message Transaction Result Message
Refer to the EBT Card 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_approval_code Transaction Approval Code
Unique code returned by the credit card processor that indicates the approval status of the transaction.
ssl_reference_number Transaction Reference Number
ssl_card_number Masked Card Number
Converge only returns the first 2 or last 4 digits of the regular PAN.
ssl_account_balance Account Balance
Available balance on the EBT account.
ssl_email Email Address
The cardholder's or customer's email address. Returned based on merchant setup.
[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.