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 list summarizes the payment transactions that you can integrate into your application through Commerce SDK:

- *Sale* - obtains real-time authorization for an EMV, magnetic stripe, contactless or manual card entry transaction and enters the transaction into the Unsettled batch
- *Pre-auth* - obtains real-time authorization for an EMV, magnetic stripe or contactless transaction, guarantees the availability of fund on the card, and reduces the cardholder's limit to buy for a pre-determined period (7 to 10 days depending on issuing bank). This transaction does not place the authorization in the Settlement batch.
- *Pre-auth increment* - increments the auth amount of a previous pre-authorization
- *Pre-auth complete* - converts a previously approved pre-authorization to a Sale transaction and places the transaction into the Open batch for settlement
- *Auth only reversal* - deletes and attempts a reversal on a previous pre-authorization transaction
- *Void* - removes a Sale, Stand alone refund, or Force sale transaction from the Open batch
- *Linked refund* - issues a partial or full refund to the cardholder's credit card or debit card
- *Stand alone refund* - issues a return to the cardholder's credit card using the full credit card number
- *Debit balance inquiry* - checks the available balance of a debit card's underlying funding account
- *Post auth tip adjust* - updates the tip (gratuity) of a credit card transaction after the transaction is authorized
- *Continue transaction* - continues transaction processing once Commerce SDK receives needed information
- *Cancel transaction* - cancels a transaction prior to authorization
- *Transaction lookup* - searches for previous Sale, Pre-auth, Refund, or Void transactions

This table summarizes the processing options that can be added to transactions.

| Processing option | Applies to | Description |
| ---- | ---- | ---- |
| Address verification service | Sale Pre-auth | Verifies the cardholder's address data with the issuing bank to minimize fraudulent transactions. |
| Force sale | Sale | Processes a transaction using the voice authorization number provided by the creditor. |
| Gratuity | Sale Pre-auth | Adds a gratuity or tip amount to the transaction amount. |
| Manual card entry | Sale Pre-auth | Allows the terminal to encrypt the card data for manually entered card number and expiration date. |
| Merchant transaction reference | Sale | Associates a reference ID with a transaction. |
| Partial approval | Sale Pre-auth | Partially authorizes a transaction when the funds on the payment card cannot cover the entire transaction amount. |
| Pay with token | Sale Pre-auth | Processes a transaction using a token instead of card data. |
| Request token | Sale Pre-auth | Request the tokenization of the card number as part of the transaction. |
| Invoice number | Sale | Adds an invoice number to the transaction to track related transactions. |
| CVM signature | Sale Pre-auth | Allows signature capture to be enabled or disabled for credit card transactions. |
| Healthcare | Sale Pre-auth | Allows healthcare terminals to specify healthcare-related amounts when processing HSA cards. |

## Prerequisite

### Send Converge credentials 

Before you can post any transaction requests, you need to send your Converge credentials to Commerce SDK using the `openPaymentGateway` command to initialize your application. After Commerce SDK receives your credentials, it uses these for all subsequent communications with Converge.

::::notice{important}

- You should execute `openPaymentGateway` only once.
- The `paymentGatewayId` parameter and value in the response must be passed to all subsequent transaction requests.
::::

#### Request

| Property | Description |
| --- | --- |
| method string required | `openPaymentGateway` |
| targetType string required | `paymentGatewayConverge` |
| parameters JSONObject required | All relevant parameters for opening a connection. |
| vendorId string required | Vendor ID Unique vendor identifier provided by Elavon. |
| vendorAppName string required | Vendor's application name |
| vendorAppVersion string required | Application version |
| userId string required | User ID |
| pin string required | PIN |
| paymentGatewayEnvironment string required | Payment gateway environment Valid values:<ul><li>PROD</li><li>DEMO</li></ul> |
| app string required | Application name |
| merchantId string required | Merchant ID |
| handleDigitalSignature boolean required | Digital signature capture capability Valid values:<ul><li>True</li><li>False</li></ul> |
| email string optional | Merchant's email address |
| overrideDefaultTerminalLanguage JSONObject optional | Language and country information *Note:* For RBA connector PIN pads only. |
| overrideDebitNetworkPreferences JSONObject required | US common debit preferences |
| bmsUsername string required | The API username used when sending request to Bridge Maintenance System. |
| bmsPassword string required | The API password used when sending request to Bridge Maintenance System. |
| healthCheckStaleTransactionTimeout integer optional | Health Check Stale Transaction Timeout value |
| healthCheckTaskTimeout integer optional | Health Check Task Timeout value |
| logLevel string optional | Log level Allowed values:<ul><li>ERROR</li><li>WARN</li><li>INFO</li><li>DEBUG</li><li>TRACE</li></ul> |
| proxyInfo JSONObject optional | Details for connecting through a network proxy. |
| address string required | Address IP address |
| port string required | Port number |
| user string optional | Username |
| password string optional | Password |
| signatureOption string optional | Signature option Allowed values:<ul><li>DISABLED</li><li>OPTIONAL</li><li>ENABLED_MSR_ONLY</li><li>ENABLED_ALL</li></ul> |
| terminalCardholderInputMode string optional | Terminal Cardholder Input Mode Allowed values:<ul><li>CARD_READER</li><li>IN_POS</li></ul> |


#### Response

| Property | Description |
| --- | --- |
| paymentGatewayId boolean | Payment gateway ID Unique payment gateway identifier to be used on all subsequent requests. |
| result boolean | Transaction result |


## Code samples

### CWS 

#### Request

```json
{
 "method" : "openPaymentGateway",
 "requestId" : "1326383996",
 "targetType" : "paymentGatewayConverge",
 "version" : "1.0",
 "parameters" : {
 "app" : "VMM",
 "email" : "******",
 "healthCheckStaleTransactionTimeout" : 0,
 "healthCheckTaskTimeout" : 0,
 "pin" : "******",
 "userId" : "******",
 "handleDigitalSignature" : true,
 "paymentGatewayEnvironment" : "DEMO",
 "merchantId" : "******",
 "terminalCardholderInputMode" : "UNSET",
 "vendorId" : "******",
 "vendorAppName" : "******",
 "vendorAppVersion" : "******",
 "bmsUsername" : "******",
 "bmsPassword" : "******",
 "overrideDefaultTerminalLanguage" : {
 "languageInformation" : {
 "languageCode" : "EN",
 "countryCode" : "US"
 }
 },
 "overrideDebitNetworkPreferences" : {
 "visa" : "NO_PREFERENCE",
 "mastercard" : "US_COMMON_DEBIT",
 "discover" : "GLOBAL_NETWORK"
 },
 "proxyInfo" : {
 "address" : "******",
 "port" : "******",
 "user" : "******",
 "password" : "******"
 }
 }
}
```

#### Response

```json
{
 "requestId" : "1326383996",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "paymentGatewayCommand" : {
 "completed" : true,
 "eventQueue" : [ ],
 "openPaymentGatewayData" : {
 "result" : "SUCCESS",
 "paymentGatewayId" : "0907356b-d985-4e3f-adae-1a74b9264a8a"
 }
 }
 }
}
```

### C\# 

```c#
OpenPaymentArgs opa = new OpenPaymentArgs(); 
opa.merchantId = MY_MERCHANT;
opa.userId = MY_USER;
opa.pin = MY_PIN;
opa.app = MY_APP;
opa.email = MY_EMAIL;
opa.vendorId = MY_VENDOR_ID;
opa.vendorAppName = MY_VENDOR_APP_NAME;
opa.vendorAppVersion = MY_VENDOR_APP_VERSION;
opa.paymentGatewayEnvironment = MY_SERVERTYPE;
opa.handleDigitalSignature = true; /* We can handle digital signature */

// The language used for transaction can be overridden.
// This applies to RBA pinpads only and will have no effect for other pinpads.
// This is completely optional. If not used, a possibly server supplied language preference info is going to be used.
// You can specify a pair of (language, country) to determine the language to be used on pinpad during a transaction.
// If the pair you supplied is not supported, the return value will indicate the language CSDK chose to use.
// This is determined to be the closest match to what you specified.
// Currently, CSDK supports English in US and English and French in Canada.
opa.overrideDefaultTerminalLanguage = new OverrideDefaultTerminalLanguage();
opa.overrideDefaultTerminalLanguage.languageInformation = new LanguageInformation();
opa.overrideDefaultTerminalLanguage.languageInformation.languageCode = MY_OVERRIDE_LANGUAGE_LANGUAGE_CODE;
opa.overrideDefaultTerminalLanguage.languageInformation.countryCode = MY_OVERRIDE_LANGUAGE_COUNTRY_CODE;

// You can override the CSDK setting for the debit network preference in the US.
// This applies to US RBA pinpads only and will have no effect for other pinpads.
// This is completely optional. If not used, a possibly server supplied value is going to be used.
// The possible choices are: global debit network, us common debit network or no preference at all,
// in which case the user will be asked to do the selection on the pinpad, if applicable.
// Be advised that in case of contactless transactions, the pinpad will not ask the user for a selection,
// but it will select the AID with the highest priority remaining after filtering them based on the setting.
// For example, if the choice is to use the global network and there 2 global AIDS on the card,
// RBA will automatically select the one with the highest priority.
opa.overrideDebitNetworkPreferences = new OverrideDebitNetworkPreferences();
opa.overrideDebitNetworkPreferences.visa = MY_VISA_PREF;
opa.overrideDebitNetworkPreferences.mastercard = MY_MASTERCARD_PREF;
opa.overrideDebitNetworkPreferences.discover = MY_DISCOVER_PREF;

OpenPaymentGatewayResults opgr = m_CWS.OpenPaymentGateway(opa, null);
MyOpenPaymentGatewayComplete(opgr);

...

public void MyOpenPaymentGatewayComplete(OpenPaymentGatewayResults opgr)
{
 OpenPaymentData opd = opgr.OpenPaymentData;
 if (null != opd)
 {
 // success, store the payment gateway id
 }
 else
 {
 // failure
 }
}
```

## RBA PINPad processing options

::section-heading-list{max-level=3 }

### RBA PINPad language 

This method overrides the language used on an RBA pinpad during a transaction.

#### Request

| Property | Description |
| --- | --- |
| method string required | `overrideDefaultTerminalLanguage` |
| requestId string required | Transaction request ID |
| targetType string required | `api` |
| parameters JSONObject required | All relevant parameters for overriding the language on an RBA pinpad. |
| languageInformation JSONObject required | Holds the language information |
| languageCode string optional | ISO language code Valid values:<ul><li>EN</li><li>FR</li></ul> |
| countryCode string optional | ISO country code Valid values:<ul><li>US</li><li>CA</li></ul> |

#### Response

| Property | Description |
| --- | --- |
| requestId string | Transaction request ID specified in request. |
| statusDetails string | Status of the request. |
| data JSONObject | Object holding various responses. |
| countryCode string | Holds the ISO country code that was set. This may differ from the code specified in the request if an unsupported value. |
| languageCode string | Holds the ISO lanugage code that was set. This may differ from the code specified in the request if an unsupported value. |
| completed boolean | Completion status of the request. |

#### Example request

```json
{
 "method" : "overrideDefaultTerminalLanguage",
 "requestId" : "386097750",
 "targetType" : "api",
 "version" : "1.0",
 "parameters" : {
 "languageInformation" : {
 "languageCode" : "EN",
 "countryCode" : "US"
 }
 }
}
```

#### Response

```json
{
 "requestId" : "386097750",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "countryCode" : "US",
 "completed" : true,
 "languageCode" : "EN"
 }
}
```

### US debit network preference 

This method overrides the US debit network preference used on an RBA pinpad during a transaction.

::::notice{note}

In case of contactless transactions, the pinpad will not ask the user for a selection but it will select the AID with the highest priority remaining after filtering these based on the setting.
::::

#### Request

| Property | Description |
| --- | --- |
| method string required | `overrideDebitNetworkPreferences` |
| requestId string required | Transaction request ID |
| targetType string required | `api` |
| parameters JSONObject required | All relevant parameters for overriding the US debit network preference on an RBA pinpad. |
| discover string optional | Preference for the Discover brand Valid values:<ul><li>GLOBAL_NETWORK</li><li>US_COMMON_DEBIT</li><li>NO_PREFERENCE</li></ul> |
| mastercard string optional | Preference for the MasterCard brand Valid values:<ul><li>GLOBAL_NETWORK</li><li>US_COMMON_DEBIT</li><li>NO_PREFERENCE</li></ul> |
| visa string optional | Preference for the Visa brand Valid values:<ul><li>GLOBAL_NETWORK</li><li>US_COMMON_DEBIT</li><li>NO_PREFERENCE</li></ul> |

#### Response

| Property | Description |
| --- | --- |
| requestId string | Transaction request ID specified in request. |
| statusDetails string | Status of the request. |
| data JSONObject | Object holding various responses. |
| completed boolean | Completion status of the request. |

#### Example request

```json
{
 "method" : "overrideDebitNetworkPreferences",
 "requestId" : "386097749",
 "targetType" : "api",
 "version" : "1.0",
 "parameters" : {
 "discover" : "GLOBAL_NETWORK",
 "mastercard" : "US_COMMON_DEBIT",
 "visa" : "NO_PREFERENCE"
 }
}
```

#### Response

```json
{
 "requestId" : "386097749",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "completed" : true
 }
}
```

Transactions

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

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

Make a Payment - Coming Soon

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

Avvance

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

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

Incoming Webhooks

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

Elavon Commerce SDK Overview

Integration Methods

Commerce Web Services

Java (Windows)

Java (Android)

Objective-C (iOS)

System

Get Environment Information

Get Converge Account Information

Validate BMS Credentials

Payment Terminals

Payment Terminals Overview

Ingenico

iCMP

iPP320

iSC250

Lane/3000

Lane/3600

Lane/5000

Link/2500

Moby/5500

RP457c

Self/4000

Card Reader Connection

Device Connection Criteria

Card Reader Configuration

Get Card Reader Information

24-Hour Reboot

On-Demand

Get Device Status

Reset Card Reader

Reboot Card Reader

Encrypted Card Read

Cancel Card Read

Prompt PIN Entry

Capture Card Data

Get Customer Input

Phone Number

Volume Control

Set Shutdown Timeout

Signature Capture

Set Time Zone on Card Reader

TMS Update Check Time Window

SSL Certificate Update Process for Card Reader

Printers

Printers Overview

Get Printer Information

Print Receipts

On Demand Print Receipt

Transaction Types

Transactions Overview

Sale

Auth Only

Auth Only Increment

Convert Auth Only to Sale

Auth Only Reversal

Void

Linked Refund

Stand Alone Refund

Debit Balance Inquiry

Post Auth Tip Adjust

Continue Transaction

Cancel Transaction

Transaction Lookup

Processing Options

Processing Options Overview

Address Verification Service

Force Sale

Gratuity

Manual Card Data Entry

Merchant Transaction Reference

Partial Approval

Token Request

Pay with Token

Retrieve CVM Signature

Invoice Number