Elavon downloads and stores cookies on your device when you visit our website. We use these cookies to better understand and improve your browsing experience by identifying most visited pages, personalising content, and measuring site performance.

Essential cookies enable core functionality such as page navigation and access to secure areas. The website cannot function properly without these cookies; they can only be disabled by changing your browser preferences.

These are cookies that support site functionality that is visible or advantageous to you or your experience of the site, they enable websites to remember choices and provide a more personalized experience.   Functional cookies help to provide services that you request, such as language preference or layout.

Performance cookies help us to improve our website by collecting and reporting information on its usage (for example, which of our pages are most frequently visited).

These cookies and similar technologies gather information about your browsing habits. They remember that you've visited a website and share this information with other organisations, such as advertisers and platforms on which we advertise. They do this in order to provide you with ads that are more relevant to you and your interests. Although these cookies and similar technologies can track your visits to other websites, they don't usually know who you are. Without these cookies, online advertisements you encounter will be less relevant to you and your interests.

Cookie Settings

U.S. Bank Europe DAC. Registered in Ireland – Number 418442..  Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
U.S. Bank Europe DAC. Registered in Ireland with Companies Registration Office. The liability of the member is limited. United Kingdom branch registered in England and Wales under the number BR022122.
U.S. Bank Europe DAC, trading as Elavon Merchant Services, is a credit institution authorised and regulated by the Central Bank of Ireland.  Authorised by the Prudential Regulation Authority.  Subject to regulation by the Financial Conduct Authority and limited regulation by the Prudential Regulation Authority.  Details about the extent of our regulation by the Prudential Regulation Authority are available from us on request.

Most popular solutions

Additional solutions

Fusebox integration & options

Optional platform features

Documentation

North America

Europe

Regions

This section describes the message parameters for Gift Card Balance Inquiry transaction processing, which you can submit using the XML API integration method. Refer to the :magic-link[Integration Methods]{id="integration-methods"} section for more information.

The `egcbalinquiry` transaction checks the current balance of a Gift Card account.

For the entire list of API endpoints, refer to :magic-link[**API Endpoints**]{id="-endpoints"}.

## Request 

| Field name | Description | Required | Length | Data type |
|--------|---------------------------------|-----------|------|-------------|
| `ssl_account_id` **Formerly known as ssl_merchant_id** | Elavon-assigned Converge Account ID (AID). **Note:**  `ssl_merchant_id` will be eventually removed from the documentation. Both fields `ssl_account_id` and `ssl_merchant_id` will remain functional in the code. | 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 **Value:**  `egcbalinquiry` | Required | 20 | alphanumeric |
| `ssl_security_code` | Card Security Code Unique verification code assigned to the cardholder's gift card account. **Important**: Required if the account is assigned with a security code. | Conditional | 6 | numeric |
| [**Card Data**] | Use the appropriate card data parameters for the transaction. | | | |
| `ssl_card_number` | Card Number Card Number as it appears on the gift card. **Important**: 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. | Conditional | 4 | numeric |
| `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. **Important**: 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 and last name. | 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. **Important**: Required if using `ssl_enc_track_data`.| Conditional | 20 | alphanumeric |
| `ssl_token` | Gift Card Token Encrypted card data that can replace `ssl_card_number`. **Important**: The token must already be stored. Use only if the terminal is set up with the *Tokenization* terminal option. | Conditional | 20 | alphanumeric |
| [**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:**<ul><li> `Y` - Generate token</li><li> `N` - Do not generate token (Default)</li></ul>If set to **Y**, the following parameters are mandatory: Hand-keyed:<ul><li> `ssl_card_number`</li><li> `ssl_exp_date`</li></ul>Swiped:<ul><li> `ssl_track_data`</li></ul>Encrypted Swiped/Contactless:<ul><li> `ssl_enc_track_data`</li></ul> | 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 :magic-link[Gift Card Response Codes]{id="electronic-gift-card-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_card_number` | Masked Card Number |
| `ssl_exp_date` | Card's Expiry Date Returned based on merchant setup. |
| `ssl_account_balance` | Account Balance Available balance on the gift card. |
| `ssl_email` | Email Address The cardholder's or customer's email address. Returned based on merchant setup. |
| `ssl_egc_tender_type` | Tender Type Tender type used to pay for the gift card. **Valid values:**<ul><li>`0` - Cash</li><li>`1` - Credit Card</li><li>`2` - Debit Card</li><li>`3` - Check</li></ul> |
| `ssl_security_code` | Card Security Code Indicates whether a security code was present on the authorization request. **Valid values:**<ul><li>`TRUE` - Security code is present</li><li>`FALSE` - Security code is not present</li></ul>**Important**: Returned only on terminals that are set up with the *Security Code* terminal option.|
| [**Tokenization**] | Returned only if *Tokenization* parameters are sent in the request. |
| `ssl_token` | Gift Card Token Generated from the card number. Returned if transaction was approved. Not returned if the transaction was failed or rejected. |
| `ssl_token_provider` | Credit Card Token Provider This code indicates the provider for the token. This value is also visible in the Converge UI. **Valid values:**<ul><li>**P** for legacy tokens.</li><li>**V** for Voltage tokens</li></ul> |
| `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`. |
| [**Error**] | Returned only if an error occurs. Refer to the :magic-link[Error Codes]{id="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

:::::notice{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 your Converge credentials, should be placed in server side code.
:::::

### Request

```XML
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_transaction_type>egcbalinquiry</ssl_transaction_type>
 <ssl_card_number>41**********1111</ssl_card_number>
 <ssl_exp_date>1230</ssl_exp_date>
 <ssl_security_code>1234</ssl_security_code>
</txn>
```

Balance Inquiry - egcbalinquiry

Alliance Offers

Data as a Service

Invitation to Apply

Bank Holidays

Card Activation

Card Controls

Challenge-Widget

Commercial Credit Cards

Commercial Statements

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Balance Transfers

Credit Card Disputes

Credit Card Payments

Credit Card Qualified Offers

Credit Card Statements

Credit Card Transactions

Data Sharing for Marketing Purposes

Digital Wallets

Incoming Webhooks

Rewards Accelerator

Rewards Automatic Redemption

Rewards: Balance Summary

Rewards: Dashboard

Rewards Redemption Accounts

Rewards Redemptions

Rewards Transactions: Earned and Redeemed

Travel Notifications

User Profile

3DSecure2

CheckoutJs

Commerce SDK

Converge

Disputes Management

Dynamic Currency Conversion

eBoarding

Elavon Cloud Payments Interface

Elavon Payment Gateway

Fusebox

Hosted Payment Page

In Person Payments on Opayo

Leads

Lightbox payment modal

Online Payments on Opayo

Opayo

Opayo Direct

Opayo Forms

Opayo Reporting API

Opayo Server

Opayo Shared API

Payment Method Gateway

Payments Core 365

Simplify

viaconex

XML API

Card as a Service API

Core Banking API

Money Movement API

Reference API

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Avvance Connect

Avvance Express

Avvance Flex

Bank Information

Card as a Service

Check Payables

Corporate Account Information

Corporate Account Information 3LO

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Debit Card Phone Number Lookup

Disbursements via Zelle®

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant payments

Investment Accounting

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

RTP® - Real-Time Payments

Tokenized Payments

Treasury Builder

U.S. Bank FBO Account

Virtual Account Reporting

Virtual Card Payments

Voyager Accounts

Voyager Cards

Voyager Drivers

Voyager Transactions

Voyager Vehicles

Wire Transfers

Converge Overview

Getting Started

Transaction Types

Credit Card Transactions Overview

Sale - ccsale

Auth only - ccauthonly

Auth Only Increment - ccauthonly

Verification - ccverify

Balance inquiry - ccbalinquiry

Return - ccreturn

Void - ccvoid

Completion - cccomplete

Delete - ccdelete

Update tip - ccupdatetip

Signature - ccsignature

Add recurring - ccaddrecurring

Update recurring - ccupdaterecurring

Delete recurring - ccdeleterecurring

Submit recurring payment - ccrecurringsale

Add installment - ccaddinstall

Update installment - ccupdateinstall

Delete installment - ccdeleteinstall

Submit installment payment - ccinstallsale

Credit card force - ccforce

Credit Card Credit - cccredit

Merchant Hosted Card On File

Debit Card Transactions

Debit Card Transactions Overview

Purchase - dbpurchase

Return - dbreturn

Auth Only - dbauthonly

Auth only Increment - dbauthonly

Complete - dbcomplete

Reverse - dbreverse

Debit - dbvoid

Delete - dbdelete

Inquiry - dbbainquiry

PINless bill pay - pldbillpay

Pinless debit purchase - pldpurchase

BIN Lookup - binlookup

Straight Send

Cash Tender Transactions

Cash Tender Transactions Overview

Sale - cashsale

Credit - cashcredit

EMV Credit/Debit Card Transactions

EMV card transactions overview

Sale - emvchipsale

Auth Only - emvchipauthonly

Swipe sale - emvswipesale

Swipe auth only - emvswipeauthonly

Card update - emvchipupdatetxn

Reversal - emvreverse

Key exchange - emvkeyexchange

Legacy key exchange - caddbkeyexchange

Interac Refunds

Return - emvchipreturn

EMV DCC check - emvdcccheck

EBT Transactions

EBT transactions overview

Food stamp benefits

Purchase - fspurchase

Return - fsreturn

Inquiry - fsbainquiry

Force purchase - fsforcepurchase

Force return - fsforcereturn

Cash benefits

Purchase - cbpurchase

Inquiry - cbbainquiry

Gift Card Transactions

Gift Card Transactions Overview

Activation - egcactivation

Sale or Redemption - egcsale

Refund - egccardrefund

Replenishment or Reload - egcreload

Balance inquiry - egcbalinquiry