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

Commerce SDK automatically handles locating and connecting to your card reader when you begin your first transaction in the *Transactional API*.

To use any of the on-demand methods, however, you must first manually connect the reader.

Connecting to the reader requires you to:

1. Create a Commerce SDK account to get an account interface.
2. Use your account interface to access the card reader interface.
3. Initiate a device search through the card reader interface.
4. Once search locates the reader, set it as the *Active*  device. All on-demand functions will run off on this device.

:::::notice{important}

Commerce SDK searches for devices over USB and Bluetooth connections by default.
To connect over your network, refer to the *Device Connection Criteria* page.
To connect to an iCMP over Bluetooth from a mobile device (iOS and Android), you must first unpair your Link/2500 device.
:::::


## Card reader updates 

At connection time, Commerce SDK automatically performs a device update if the operating system or configuration is out of date. After the update, you will receive a `cardReaderInitialized` callback and you will be able to begin using the on-demand functions on the card reader.

### Update progress
 
Callbacks for the status and progress of updates are sent to the ECLCardReaderListener (Java) or ECLCardReaderDelegate (iOS). Progress messages indicating updates starting and completing are sent to the cardReaderProgress method. Additionally, the cardReaderUpdateProgress method receives callbacks indicating the percent complete of the update and the current operation being performed. This method will be called at each 5% interval of the total update time (with the exception that some 5% intervals may be skipped if a step finishes sooner than expected) and is suitable for displaying a progress bar if desired.

### Preventing automatic updates

If you would like to have more control over when the device update occurs, you can instruct Commerce SDK to prevent updates to the device until you are ready. This option is documented in the code examples below. Please note that if you choose to prevent an update from taking place, you will be unable to use any functions on the device until it has been successfully updated.

If you are using the CWS or C\# interfaces, you need to do one extra step to prevent updates from occuring. In the `cws-config.properties` file, you need to add `updateCardReaderIfNecessary=false` to prevent CWS from updating the first device it connects to when the process starts. After CWS has started, the `updateIfNecessary` value you pass in to the API methods below will override the value set in the properties file when you are ready to connect and update.

## Code samples

### CWS 

```json
// Each of the three items in the parameters section below are optional
// timeout is a millisecond value that represents the amount of time CSDK should search for devices before it gives up
// updateIfNecessary controls whether or not an update is allowed to occur as part of a device connection
// connect boolean lets you specify whether or not you want CSDK to connect to the first device it finds (this is the default behavior)
{
 "method" : "startCardReadersSearch",
 "requestId" : "1",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "timeout" : 9000,
 "updateIfNecessary":true,
 "connect":true
 }
}

// you will immediately receive back a response that looks like this
{
 "requestId": "1",
 "statusDetails": "REQUEST_ACCEPTED",
 "data": {
 "cardReadersSearch": {
 "timeout": 9000,
 "commandId": "1",
 "connect": true,
 "updateIfNecessary": true,
 "completed": false,
 "error": null,
 "cardReaders": []
 }
 }
}

// From this point on, while Commerce SDK is searching for a device for you, you will poll CWS by sending it status requests like this.
// The commandId should match the commandId you received from the last response.
{
 "method" : "getCardReadersSearchStatus",
 "requestId" : "2",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "commandId" : "1"
 }
}

// You will immediately receive a response that contains the most current results of the search process.
// You can see that the search is finished because the completed flag is true. If it was not true, you will need to continue polling cws until it is true. 
// One card reader was found in this case. You should also check the error value to see if anything went wrong during the process.
{
 "requestId": "2",
 "statusDetails": "COMMAND_STATUS",
 "data": {
 "cardReadersSearch": {
 "timeout": 9000,
 "commandId": "1",
 "connect": true,
 "updateIfNecessary": true,
 "completed": true,
 "error": null,
 "cardReaders": [
 "iPP320"
 ]
 }
 }
}
```

### Java 

#### Simplified connection flow

Refer to the desktop sample application source code for more information.

On Android platform upon Commerce SDK trying to search device over an SSL-based IP channel, the certificate file and certificate key streams need to be reset prior to the search. This can be done in the callback method `uponSearchingDevices` on interface ECLFindDevicesListener as demonstrated in the sample code below.

```java
// get a hold of the cardreaders interface
ECLDevicesInterface<ECLCardReaderInterface> cardReadersInterface = eclAccountInterface.getCardReaders();
// kick off a device search and setup a listener to receive callbacks from the search
cardReadersInterface.findDevices(new ECLFindDevicesListener() {
 @Override
 public void uponSearchingDevices(EnumSet<ECLConnectionType> connectionTypes)
 {
 if (connectionTypes.contains(ECLConnectionType.IP))
 {
 try
 {
 Flavor.initializeCertificateFiles();
 }
 catch (IOException e)
 {
 displayMessageInProgressView("failed to initialize certficate files", false);
 return;
 }
 }
 }

 public void devicesSearchDone(List<ECLFindDevicesSearchResult> deviceSearchResults)
 {
 ...
 if (deviceSearchResults.size() > 0) {
 ECLFindDevicesSearchResult result = deviceSearchResults.get(0);
 // set this card reader as the active device
 cardReaderInterface =
 cardReadersInterface.selectDevice(result.getName(), result.getConnectionTypes());
 ...
 // add connection listener to receive disconnect callbacks
 cardReaderInterface.addConnectionListener( new CardReaderListenerAdapter(...));
 ....
 // connect and initialize the device. if an update is necessary, perform the update.
 // if the parameter is set to false, the device will not be updated even if one was necessary. In this case, if an update was needed, 
 // you would receive a ECLCardReaderNeedsUpdate in your cardreaderconnectionorinitializationerror callback and the card reader would be disconnected.
 // when you are ready for the card reader to be updated, you'd call connectAndInitialize again this time passing a parameter of "true"
 cardReaderInterface.connectAndInitialize(true);
 }
 }
```

### Objective-C 

#### Simplified flow

Refer to the sample application source code for more information.

```objc
// get a hold of card readers implementation of the devices protocol from the account
id<ECLDevicesProtocol> devices = [_account cardReaders];

// kick off a device search
[devices findDevices:self forceToDisconnect:true timeoutInSeconds:30];

// in this case we made the current class receive the findDevices callbacks (note the reference to "self" above)
...

// the implementation of one of the findDevices callbacks
+ (void)devicesSearchDone:(id<ECLDevicesProtocol>)devices searchResults:(NSArray<ECLFindDevicesSearchResult *> *)deviceSearchResults {
 ...
 if ([searchResults count] > 0) {
 // make this device the "active" device
 ECLFindDevicesSearchResult *reader = deviceSearchResults[0];
 id<ECLDeviceProtocol> selectedDevice = [devices selectDevice:reader.name withConnectionTypes:reader.connectionTypes];
 id<ECLCardReaderProtocol> selectedCardReader = (id<ECLCardReaderProtocol>)selectedDevice;

 // register this class to receive connection related callbacks
 [selectedCardReader addConnectionDelegate:self];

 // connect and initialize the device. if an update is necessary, perform the update.
 // if the parameter is set to NO, the device will not be updated even if one was necessary. In this case, if an update was needed,
 // you would receive a ECLCardReaderNeedsUpdate in your cardreaderconnectionorinitializationerror callback and the card reader would be disconnected.
 // when you are ready for the card reader to be updated, you'd call connectAndInitialize again this time passing a parameter of "YES"
 [selectedCardReader connectAndInitialize:YES];
 ...
```

### C\# 

#### Device search or connection

Refer to the sample application source code for more information.

```c#
// start a card reader search and return a search results object which contains the list of attached card readers. If only one device was found, it will be connected and initialized automatically. 
ReaderSearchResults rsr = m_CWS.ReaderSearch(null);
```

Card reader connection

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