Balance Inquiry - ccbalinquiry

This section describes the message parameters for Credit Card Balance Inquiry transaction processing, which you can submit using the Hosted Payments, Checkout.js, and XML API integration methods. Refer to the Integration Methods section for more information.

The ccbalinquiry transaction returns the balance of a pre-paid card.

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. 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: `ccbalinquiry`	Required	20	alphanumeric
[Card Data]	Use the appropriate card data parameters for the transaction.
`ssl_card_number`	Card number Card number as it appears on the credit card. Required for hand-keyed transactions.	Conditional	18	numeric
`ssl_exp_date`	Card’s Expiry Date Date when the card becomes invalid. Format: MMYY Important: Required if `ssl_card_number` is not null. Do not send the expiry date when the token is stored in Card Manager.	Conditional	4	numeric
`ssl_card_present`	Card Present Indicator Indicates whether the card is physically present during the transaction. Recommended for hand-keyed transactions. Valid values: `Y` - Card present `N` - Card not present	Optional	1	alphanumeric
`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 transactions.	Conditional	76	alphanumeric
`ssl_enc_track_data`	Encrypted Raw Track I and/or II Data Encrypted Track I and/or II data captured from the card’s magnetic stripe when using an Ingenico encrypting device. The data includes beginning and ending sentinels, card’s expiry date, cardholder’s first name and last name.	Conditional	160	alphanumeric
`ssl_enc_track_data_format`	Encrypted Raw Track I and/or II Data Format Format of the track data captured from the card’s magnetic stripe. Valid value: `ROAM_GENERIC_TDES_EMV` Required if card is read from a ROAM device.	Conditional	NA	NA
`ssl_ksn`	Key Serial Number Unique identifier generated from the swiped payment card and returned by the encrypting device. The KSN encrypts the PAN data through the DUKPT method. Required if using `ssl_enc_track_data`.	Conditional	20	alphanumeric
`ssl_vm_mobile_source`	Mobile Source Valid values: `BBERRY` - BlackBerry mobile device `ADROID` - Android mobile device `ITUNES` - Apple mobile device `WIN8` - Windows WIN8-based Device `NOMOB` - Non-mobile Device Required for encrypting devices.	Conditional	NA	alphanumeric
`ssl_vendor_id`	Vendor ID Unique vendor identifier assigned by Elavon. Required for encrypting devices and certification.	Conditional	8	alphanumeric
`ssl_mobile_id`	Mobile ID Unique assigned mobile identification number of each mobile device in use as determined by the merchant. Optional for encrypting devices.	Conditional	50	alphanumeric
`ssl_token`	Credit Card Token Encrypted card data that can replace `ssl_card_number`. Important: The token must already be stored in Card Manager. Use only if the terminal is set up with the Tokenization terminal option.	Conditional	20	alphanumeric
`ssl_pos_mode`	POS Device Data Entry Capability Indicates how the POS device captures card data. Valid values: `01` - Manual entry only `02` - Magnetic swipe-capable `03` - Proximity or contactless-capable `04` - EMV chip-capable (ICC) - Contact only with magnetic stripe `05` - EMV chip-capable (ICC) - Dual interface with magnetic stripe	Optional	2	numeric
`ssl_entry_mode`	Transaction Entry Indicator Indicates how the track data was captured. Valid values: `01` - Key entered - Card not present `02` - Key entered - Card present `03` - Swiped (default)	Optional	2	numeric
[Tokenization]	Use only on terminals that are set up with the Tokenization terminal option.
`ssl_get_token`	Generate Token Indicator Indicates whether to generate a token when submitting the card data. Valid values: `Y` - Authorize transaction and generate token `N` - Do not generate token (Default) If set to Y, the following parameters are mandatory: Hand-keyed: `ssl_card_number`, `ssl_exp_date` Swiped: `ssl_track_data` Encrypted Swiped/Contactless `ssl_enc_track_data`	Optional	1	alphanumeric
`ssl_add_token`	Add to Card Manager Indicator Indicates whether to add token and cardholder details to Card Manager. Valid values: `Y` - Add or update the generated token and the cardholder details if the transaction is approved `N` - Do not add the token or the cardholder details (Default)	Optional	1	alphanumeric

Response

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 Payment Card Response Codes section for an extensive list of possible returned messages.
`ssl_issuer_response`	Original Issuer Response The issuer response returned during the authorization attempt. An `ssl_issuer_response` = 00 indicates success. An `ssl_issuer_response` not equal to 00 indicates a decline or failure.
`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/2022 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_account_balance`	Account Balance
`ssl_card_short_description`	Short Card Brand Name Valid values: `AMEX`, `CUP`, `DISC`, `MC`, `PP`, and `VISA`
`ssl_card_number`	Masked Card Number Converge only returns the first 2 or last 4 digits of the regular PAN, or the last 4 digits of the actual card number if it is an association token (example, ApplePay).
[Tokenization]	Returned only if Tokenization parameters are sent in the request.
`ssl_token`	Token Generated from the credit card number. Returned if transaction was approved. Not returned if the transaction was failed or rejected.
`ssl_token_response`	Token Generation Outcome A value of `SUCCESS` indicates Converge generated the token. Other values returned are `FAILURE`, `Action Not Permitted`, `Invalid Token`, `Not Permitted`, and `Acct Verification Failed`.
`ssl_add_token_response`	Add to Card Manager Outcome Valid values: `Card Added`, `Card Updated`, `Not Permitted`, `FAILURE - First Name` - is required
[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.

Example

important

In this example, you will have to change the data values, such as my_merchant_id, my_user_id, my_pin, and transaction data to match your Converge account and meet the needs of your website.
Code samples provided are for demonstration only and should not be used for live transactions. All sensitive merchant data, including transaction amounts and your Converge credentials, should be placed in server side code.

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_test_mode>false</ssl_test_mode>
    <ssl_transaction_type>ccbalinquiry</ssl_transaction_type>
    <ssl_card_number>4111111111111111</ssl_card_number>
    <ssl_exp_date>12/22</ssl_exp_date>
</txn>

Response

<txn>
    <ssl_issuer_response>00</ssl_issuer_response>
    <ssl_transaction_type>INQUIRY</ssl_transaction_type>
    <ssl_card_number>41**********1111</ssl_card_number>
    <ssl_result>0</ssl_result>
    <ssl_txn_id>280422A41-0F17C6AA-B0DC-4F01-84C3-37C0FD7F399A</ssl_txn_id>
    <ssl_avs_response> </ssl_avs_response>
    <ssl_approval_code>734174</ssl_approval_code>
    <ssl_transaction_currency>CAD</ssl_transaction_currency>
    <ssl_txn_time>04/28/2022 06:15:13 PM</ssl_txn_time>
    <ssl_account_balance>0.00</ssl_account_balance>
    <ssl_exp_date>1222</ssl_exp_date>
    <ssl_result_message>APPROVAL</ssl_result_message>
    <ssl_card_short_description>VISA</ssl_card_short_description>
    <ssl_card_type>CREDITCARD</ssl_card_type>
    <ssl_cvv2_response></ssl_cvv2_response>
    <ssl_partner_app_id>01</ssl_partner_app_id>
</txn>

Cash Advance

Apple Pay

Magento Guide

Balance Inquiry - ccbalinquiry

Request

Response

Example

Request

Response