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.
cbbainquiry transaction returns the current available balance of the EBT account.
In this section:
For the entire list of API endpoints, refer to API Endpoints.
|Field name||Description||Required||Length||Data type|
Elavon-assigned Converge Account ID (AID).
|Required||6 or 7||numeric|
|Converge User ID|
The user ID with Hosted Payment API User status that can send transaction requests through the terminal.
Unique identifier of the terminal that will process the transaction request and submit to the Converge gateway.
|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.
|[PIN Pad]||Values returned by the PIN Pad device.|
Value used to encrypt the PIN of the cardholder.
|Triple-DES DUKPT Pointer|
Indicates the encryption key used on US debit transactions.
|Encrypted PIN Block|
The encrypted personal identification number entered by the EBT cardholder to authenticate ownership of the card.
|Transaction Result Message|
Refer to the EBT Card Response Codes section for an extensive list of possible returned messages.
Unique identifier of the transaction.
|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
|Transaction Approval Code|
Unique code returned by the credit card processor that indicates the approval status of the transaction.
|Transaction Reference Number|
|Masked Card Number|
Converge only returns the first 2 or last 4 digits of the regular PAN.
Available balance on the EBT account.
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.|
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.
Detailed explanation of the error. This field may be changed based on merchant configuration in the user interface.
Error name or reason for the error.