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

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

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.

Per PCI specifications PCI V4 pinpads are required to reboot every 24 hours. This API allows integrators to customize the time the device will reboot.

This table lists the supported V4 pinpads.

| Model | Device Software |
| ---- | ---- |
| iPP320 V4 | RBA |
| iSC250 V4 | RBA |
| Link/2500 | UPP |
| Lane/3000 | UPP |
| Lane/5000 | UPP |
| Self/4000 | UPP |
| Lane/3600 | UPP |

:::::notice{note}

- This method requires a valid V4 connected card reader.

- Moby device reboots every 20 hours. There is no way to set a reboot time on that device. Integrators can force a reboot using on-demand reboot (refer to the Reboot Card Reader page).
:::::


By default, Commerce SDK will set the reboot time for these devices so that the automatic reboot will occur at 4:00 AM point-of-sale time. This default reboot time will be set upon the first connection to the device as part of the configuration update. Note that for the iPP320 and the iSC250, there are also V3 versions which do not need to meet the 24-hour reboot requirement, and the reboot time will not be set for these devices.

In order to meet the specific needs of the customer, the reboot time can be changed to another time using the on-demand daily reboot time API. Each time the reboot time is changed, the pinpad will do an additional reboot to apply the change. You can also set up a listener to be notified 15 minutes and 90 seconds prior to the reboot time being reached.

Note that with older CSDK versions, the set reboot time for UPP devices is not the exact time the device will reboot. There is a 30-minute window after the set reboot time, and it may reboot at any point during this window. For example, if the reboot time is set to the default 4:00 AM, then the device may reboot at any point from 4:00 AM to 4:30 AM.

Starting with Commerce SDK 5.2, the new 24-hour reboot option allows the UPP card reader to reboot at the exact set reboot time, instead of the previous 30-minute window.


## Code Samples

### CWS 

#### Request

| Property | Description |
| --- | --- |
| method string required | `setDailyRebootTimeOnCardReader` |
| requestId string required | Transaction Request ID |
| targetType string required | `cardReader` |
| parameters JSONObject required | All relevant parameters to setting the reboot time. |
| rebootTime JSONObject required | Reboot Time Object holding the reboot time properties. |
| hour int optional | Hour **Valid value:** 0 - 23 |
| minute int optional | Minute **Valid value:** 0 - 59 |

#### Response

| Property | Description |
| --- | --- |
| requestId string | Transaction Request ID As specified in the request. |
| statusDetails string | Request Status |
| data JSONObject | Object holding various responses. |
| completed boolean | Request Result Card reader reboot time setting result. |

#### Example

##### Request

```json
{
 "method" : "setDailyRebootTimeOnCardReader",
 "requestId" : "1771761000",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "rebootTime" : {
 "hour" : 5,
 "minute" : 35
 }
 }
}
```

Later to query the status of the command.

```json
{
 "method" : "getCommandStatusOnCardReader",
 "requestId" : "1771761003",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "id" : "1771761000"
 }
}
```

##### Response

Not Yet Complete

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

Complete

```json
// Note that the pin pad reboots and there is a disconnected event
{
 "requestId" : "1771761003",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "cardReaderCommand" : {
 "id" : "1771761000",
 "completed" : true,
 "eventQueue" : [ {
 "timeStamp" : "1548701990376",
 "statusDetails" : "PIN_PAD_REBOOTING"
 }, {
 "timeStamp" : "1548701990378",
 "statusDetails" : "SET_DAILY_REBOOT_TIME_COMPLETED"
 }, {
 "timeStamp" : "1548701990379",
 "statusDetails" : "SET_REBOOT_TIME_SUCCEEDED"
 }, {
 "timeStamp" : "1548701990381",
 "statusDetails" : "PIN_PAD_DISCONNECTED"
 } ]
 }
 }
}
```

#### Request

| Property | Description |
| --- | --- |
| method string required | `getDailyRebootTimeOnCardReader` |
| requestId string required | Transaction Request ID |
| targetType string required | `cardReader` |
| parameters JSONObject required | All relevant parameters to retrieving the daily reboot time. |

#### Response

| Property | Description |
| --- | --- |
| requestId string | Transaction Request ID As specified in the request. |
| statusDetails string | Request Status |
| data JSONObject | Object holding various responses. |
| completed boolean | Request Result Card reader reboot time setting result. |
| rebootTime JSONObject | Reboot Time Object holding the reboot time properties. |
| hour int | Hour **Valid value:** 0 - 23 |
| minute int | Minute **Valid value:** 0 - 59 |

#### Example

##### Request

```json
{
 "method" : "getDailyRebootTimeOnCardReader",
 "requestId" : "1771761004",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : { }
}
```

Later to query the status of the command.

```json
{
 "method" : "getCommandStatusOnCardReader",
 "requestId" : "1771761005",
 "targetType" : "cardReader",
 "version" : "1.0",
 "parameters" : {
 "id" : "1771761004"
 }
}
```

##### Response

Not Yet Complete

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

Complete

```json
{
 "requestId" : "1771761005",
 "statusDetails" : "REQUEST_ACCEPTED",
 "data" : {
 "cardReaderCommand" : {
 "id" : "1771761004",
 "completed" : true,
 "eventQueue" : [ {
 "timeStamp" : "1548702773647",
 "statusDetails" : "GET_REBOOT_TIME_SUCCEEDED"
 } ],
 "dailyRebootTimeData" : {
 "rebootTime" : {
 "hour" : 5,
 "minute: 35
 }
 }
 }
 }
}
```

### Java 

```java
// want to set reboot time to 5:35 AM
// to reset the reboot time to default, pass in null
ECLTime rebootTime = new ECLTime(5, 35);

// connected card reader
ECLCardReaderInterface cardReaderInterface = account.getCardReaders().getSelectedDevice();
cardReaderInterface.setDailyRebootTime(rebootTime, new ECLCardReaderSetDailyRebootTimeListener()
{
 // implement listener
});

// get the reboot time
cardReaderInterface.getDailyRebootTime(new ECLCardReaderGetDailyRebootTimeListener()
{
 // implement listener
});
```

### Objective-C 

```objc
// want to set reboot time to 5:35 AM
// to reset the reboot time to default, pass in NULL
ECLTime *wantedRebootTime = [[ECLTime alloc] initWithHour:5 minute:35];
// pass in reboot time and implementation of ECLCardReaderSetDailyRebootTimeDelegate
[cardReader setDailyRebootTime:wantedRebootTime delegate:self];

// get the reboot time
// pass in implementation of ECLCardReaderGetDailyRebootTimeDelegate
[cardReader getDailyRebootTime:self];

```

### C\# 

```c#
// set reboot time
// delegate to handle results
private void MySetRebootTimeComplete(SetDailyRebootTimeResults drt)
{
 String error = drt.Error;
 if ((null != error) && (error.Length > 0))
 {
 // setting reboot time failed
 }
 else
 {
 // setting reboot time was successful
 }
}

Time args = new Time(5, 35);
m_CWS.StartSetDailyRebootTime(args, MyNotifyCWSEvent, MySetRebootTimeComplete);

// get reboot time
// delegate to handle results
private void MyGetRebootTimeComplete(GetDailyRebootTimeResults drt)
{
 Time rebootTime = drt.GetRebootTime;
 if (null != rebootTime)
 {
 // handle reboot time result
 }
}

m_CWS.StartGetDailyRebootTime(MyNotifyCWSEvent, MyGetRebootTimeComplete);

```

24-Hour Reboot

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

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

Card Reader Configuration

Get Card Reader Information

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

Service Fee In-App