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:

Request

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

important

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

important

Required for hand-keyed transactions.

Conditional 18 numeric
ssl_exp_date Card's Expiry Date
Date when the card becomes invalid.
Format: MMYY
error_outline

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

important

Required for swiped and contactless 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
error_outline

important

Required if card is read from a ROAM device.

Conditional NA NA
ssl_encrypted_track1_data Encrypted Raw Track I Data
Encrypted Track I data captured from the card's magnetic stripe when using a MagTek encrypting device. The data includes beginning and ending sentinels, card's expiry date, cardholder's first name and last name.
error_outline

important

Required for swiped and contactless transactions.

Conditional 160 alphanumeric
ssl_encrypted_track2_data Encrypted Raw Track II Data
Encrypted Track II data captured from the card's magnetic stripe when using a MagTek encrypting device.
Conditional 160 alphanumeric
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.
error_outline

important

Required if using ssl_enc_track_data, ssl_encrypted_track1_data or ssl_encrypted_track2_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
error_outline

important

Required for encrypting devices.

Conditional NA alphanumeric
ssl_vendor_id Vendor ID
Unique vendor identifier assigned by Elavon.
error_outline

important

Required for encrypting devices.

Conditional 8 alphanumeric
ssl_mobile_id Mobile ID
Unique assigned mobile identification number of each mobile device in use as determined by the merchant.
error_outline

important

Optional for encrypting devices.

Conditional 50 alphanumeric
ssl_token Credit Card Token
Encrypted card data that can replace ssl_card_number.
error_outline

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)
04 - Proximity/Contactless
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/Contactless
- ssl_track_data
- Encrypted Swiped/Contactless
- ssl_enc_track_data (Ingenico)
- ssl_encrypted_track1_data (MagTek)
- ssl_encrypted_track2_data (MagTek)
Optional 1 alphanumeric
ssl_add_token Add to Card Manager Indicator
Indicates whether to generate and store the token in Card Manager.
Valid values:
Y - Authorize transaction, generate and store token
N - Do not store token (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_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_account_balance Account Balance
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.
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.