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.

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

Cookie Settings

Elavon Financial Services DAC. Registered in Ireland – Number 418442.
Registered Office: Block F1, Cherrywood Business Park, Dublin 18, D18 W2X7, Ireland.
Elavon Financial Services DAC, trading as Elavon Merchant Services, is regulated by the Central Bank of Ireland.
 
Elavon Financial Services 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.
Elavon Financial Services 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.

This command allows integration software to configure a card reader.  The integration software can only send this command to CWS installed on the local machine. If the command is successfully executed, the card reader will be rebooted.
This command works for UPP card readers.  Examples of UPP card readers are Lane/3000, Lane/5000, Self/4000.
The card reader can be configured to USB or to IP.  IP includes several options including: DHCP or STATIC, TLS_12 or NONE.

## Code Samples

### CWS 

#### Request

##### Example Configuration to IP and BootProtocol is STATIC

```json
{
    "requestId":"-1590004978",
    "targetType":"cardReader",
    "method":"startConnectionConfigurationOnCardReader",
    "parameters":
    {
        "connectionTypeStr" : "IP",         
        "inetBootProtocolStr" : "STATIC",
        "inetAddress": {
            "csdkServerMode":false,
            "encryptionScheme":"TLS_12",
            "host":"192.168.10.100",
            "port":49152
        },
        "inetStaticSettings" : {
            "address" : "192.168.86.94",
            "dns1" : "",
            "dns2" : "",
            "gateway" : "",
            "netMask" : ""
        }
     }
}
```

##### Example Configuration to USB

```json
{
    "requestId":"-1590004978",
    "targetType":"cardReader",
    "method":"startConnectionConfigurationOnCardReader",
    "parameters":
    {
        "connectionTypeStr" : "USB"       
    }
}
```

#### Response

```json
{
    "requestId":"-1590004978",
    "statusDetails":"REQUEST_ACCEPTED",
    "data":
    {
        "cardReaderCommand":
        {
            "id":"-1590004978",
            "completed":false,
            "eventQueue":[]
        }
    }
}
```

#### Status Update

If the *complete* flag in response is false, client should send in status update request periodically. The following is an example of the request.

```json
{
    "requestId":"-462232597",
    "targetType":"cardReader",
    "method":"getCommandStatusOnCardReader",
    "parameters":
    {
        "id": "-1590004978"
    }
}
```

##### Response for Status Update

If the command is successfully executed, field **completed*** is set to true and **statusDetails** is set to *REQUEST_ACCEPTED*,

```json
{
    "requestId":"-1779158281",
    "statusDetails":"REQUEST_ACCEPTED",
    "data":{
        "cardReaderCommand":{
            "id":"-1590004978",
            "completed":true,
            "eventQueue":[
                 {"timeStamp":"1646785974991","statusDetails":"CARD_READER_CONFIGURATION_UPDATE_STARTED"},
                 {"timeStamp":"1646785975135","statusDetails":"CONFIGURATION_UPDATE_FILE_DEPLOYED"},
                 {"timeStamp":"1646785975163","statusDetails":"CARD_READER_CONFIGURATION_UPDATE_COMPLETED"},
                 {"timeStamp":"1646785975163","statusDetails":"CONFIGURE_CARD_READER_CONNECTION_SUCCEEDED"}
            ]
        }
    }
}
```

Otherwise, **statusDetails** will be set to different error codes, listed below:

| Error Code | Meaning |
| --- | --- |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_HOST | Either the host parameter in InetAddress is missing or the host parameter value is invalid |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_DNS1 | When BootProtocol is STATIC and DNS1 is invalid. |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_DNS2 | When BootProtocol is STATIC and DNS2 is invalid. |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_GATEWAY | When BootProtocol is STATIC and GATEWAY is invalid. |
|CARD_READER_CONFIGURATION_UPDATE_INVALID_IPADDRESS | When BootProtocol is STATIC and IPADDRESS is invalid. |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_NETMASK | When BootProtocol is STATIC and NETMASK is invalid. |
| CARD_READER_CONFIGURATION_UPDATE_INVALID_PORT | Either the port parameter InetAddress is missing or the port parameter value is invalid. |
| CARD_READER_CONFIGURATION_UPDATE_NOT_SUPPORTED | Configuration update is not supported. |
| UNKNOWN_ERROR | Unspecified error occurred during the operation. |


### C\#


#### Example Configuration to IP and BootProtocol is STATIC

```c#
CardReaderConnection args = new CardReaderConnection();
args.connectionTypeStr = "IP";
args.inetBootProtocolStr = "STATIC";  // can specify DHCP or STATIC if STATIC must also provide InetStaticSettings
 
args.inetAddress = new InetAddress( "192.168.10.100",        // host
                                    49152,                   // port
                                    EncryptionScheme.TLS_12, // encryption scheme or string "TLS_12"
                                    false);                  // csdk is client therefore reader will be server
 
args.inetStaticSettings = new InetStaticSettings("192.168.10.101", // the desired static IP address
                                                 null,             // net mask - optional if specified will be updated on card reader
                                                 null,             // gateway - optional if specified will be updated on card reader
                                                 null,             // DNS 1 - optional if specified will be updated on card reader
                                                 null);            // DNS 2 - optional if specified will be updated on card reader
 
m_CWS.StartConfigureCardReaderConnection(args, MyNotifyCWSEvent, MyConfigureCardReaderConnectionComplete);
```

#### Example Configuration to USB

```c#
CardReaderConnection args = new CardReaderConnection();
args.connectionTypeStr = "USB";
m_CWS.StartConfigureCardReaderConnection(args, MyNotifyCWSEvent, MyConfigureCardReaderConnectionComplete);
```

Card Reader Configuration

Alliance Offers

Data as a Service

Invitation to Apply

Accounts

Bank Holidays

Card Activation

Card Controls

Commercial Credit Cards

Credit Card Account Details

Credit Card Accounts Overview

Credit Card Alerts

Credit Card Application Status

Credit Card APRs

Credit Card Disputes - Coming Soon

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 Redemption - Coming Soon

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

Access Online Transactions

Account Transfers

Account Validation

ACH Originations

Bank Information

Card as a Service

Card as a Service API

Check Payables

Core Banking API

Corporate Account Information

Corporate Credit Cards

Corporate Onboarding

Corporate Statements

Custody

Data Toolbox

Data Toolbox - Accounts

Data Toolbox - Documents

Data Toolbox - Transactions

Disbursements via Zelle®

U.S. Bank Flexible Capital Platform

Freight Payment Customer Profiles

Freight Payment Transactions

Instant Payments

Investment Accounting

Money Movement API

PaySmart

Payee Choice

Payee Token+

Personal Loans

Positive Pay

Push to Card

Receivables

Reference API

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

Getting Started

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 5000

Link 2500

Moby 5500

RP457c

Self 4000

Card Reader Connection

Device Connection Criteria

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

Lane Number

OAR-PS2000 Data

Healthcare

Dynamic currency conversion

Credit Surcharge

Credit Surcharge Overview

Surcharge Property Retrieval

Token Transaction for Surcharge

Transaction Outcome Field for Surcharge

Transaction Search Result for Surcharge

Surcharge In-App

Service Fee

Service Fee Overview

Service Fee Property Retrieval

Token Transaction for Service Fee

Transaction Outcome Field for Service Fee

Transaction Search Result for Service Fee