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

To cancel a transaction or process on a device, send a cancellation request to clear the device. This can be done to cancel the transaction while the device screen is showing **"Tap/Slide/Swipe Card / Enter Account"**.

Depending on the state of the transaction in the PIN pad, it may be too late to cancel the transaction. Typically, after the customer has pressed **OK** on the device, the payment details are sent to the payment gateway (i.e., Fusebox) and it is too late to cancel.

The cancel request is also used when timeout protocol flows are needed. For example, if a customer changes their mind and walks away from the PIN pad, the device is still waiting for someone to insert/tap/swipe their card because the cancel button wasn't physically pushed. In this case, the Integrator should send the cancel command, which tells the device to go back to the Home screen. This ensures the POS is in sync with the PIN pad so the next customer in line does not use their card to pay for the previous transaction.

## Request

### Request URI

The request URI for cancelling transactions is: 

`POST https://{host}/devices/{deviceId}/message`

### Request body

The request body contains the following `message` object parameters in a JSON payload:

-   `referenceNumber`
-   `transType = "CANCEL"`
-   `identifiers`
-   `transactionDateTime`
-   `businessDate`
-   `cashierId`

For full details and a complete list of parameters, see :magic-link[Transaction details]{id="creating-a-transaction#transaction-details"}.

### Request example
```json
{
    "responseChannelType": "SYNCHRONOUS",
    "responseChannel": {
        "responsePayloadFormat": "DEVICEMESSAGE"
    },
    "messageId": "VMH1sJKCiEaRStqV",
    "messageType": "application/vnd.elavon.transaction-b.v1+json",
    "message": {
        "referenceNumber": "1123457",
        "transType": "CANCEL",
        "identifiers": {
            "chain": "TSTLA3",
            "location": "SIMTEST",
            "terminal": "RETERM1"
        },
        "transactionDateTime": "2021-11-08 12:34:41",
        "businessDate": "110821",
        "cashierId": "Cashier"
    }
}
```

## Response

### Response HTTP codes

| Code            | Comment                                                                                                                           |
|-----------------|-----------------------------------------------------------------------------------------------------------------------------------|
| 200 OK          | Success - details in response body.                                                                                               |
| 401 Bad Request | Failure - due to the token missing from the request authorization header. Header must include "Authorization: Bearer {token}".    |
| 403 Forbidden   | Failure - due to using the wrong token (either the integratorId in the URL does not match the token, or the token is incorrect).  |
| 404 Not Found   | Failure - please contact your Elavon Cloud Payments Interface administrator. Not able to contact Elavon Cloud Payments Interface. |

### Response body

#### Successful

If the device is found and the result was successful, the response body contains the following `message` object fields in a JSON payload:

-   `transType`, `referenceNumber`, `identifiers`, `businessDate`, `transactionDateTime`, `cashierId` matching those in the request
-   additional identifiers, including the cancel `transId`, `hpiLoggingId`, `hpiTrackingNumber`
-   `response` object containing
    -   `responseCode` - "0000" if the cancellation is successful
    -   `responseText` - "SUCCESSFUL" if the cancellation is successful
    -   `rawData` - the Gateway API raw response

For full details and a complete list of fields, see :magic-link[payment devices]{id="creating-a-transaction#transaction-details"}.
```

```
##### Example

200 OK
```json
{
    "messageId": "VMH1sJKCiEaRStqV",
    "responseChannelType": "SYNCHRONOUS",
    "responseChannel": {
        "responsePayloadFormat": "DEVICEMESSAGE"
    },
    "messageType": "application/vnd.elavon.transaction-b.v1+json",
    "message": {
        "referenceNumber": 1123457,
        "identifiers": {
            "chain": "TSTLA3",
            "location": "SIMTEST",
            "terminal": "RETERM1",
            "transId": "txRPGV2cqJ9qfm69",
            "hpiLoggingId": "HRwRfQM4",
            "hpiTrackingNumber": "HPI-3.1.0-API-V2;intId:TrRh6CfXdw6dmthM;deviceId:JGrYdxkKFhjMY9bf"
        },
        "transType": "CANCEL",
        "transactionDateTime": "2021-11-08T12:34:41Z",
        "businessDate": "110821",
        "cashierId": "Cashier",
        "response": {
            "responseCode": "0000",
            "responseText": "SUCCESSFUL",
            "rawData": "0001,80\r\n0007,1123457\r\n0011,035?V15N-OG-2.03B42715\r\n 0013,122221\r\n0014,212220\r\n5002,13563332\r\n5013,r2h7tXcB4MTkMWkc\r\n"
        }
    }
}
```

#### Unsuccessful

Depending on the reason, the response body will contain details from either the device itself or from Elavon Cloud Payments Interface.

##### Device error

If the device returns the error, the response body contains a **message** parameter with a value of "Not Found", and a **details** object containing an **errorDetail** object with additional error details.
```

```
###### 404 Not Found (Cancel failed, from device)

```json
{
    "code": "404.0809.0105",
    "message": "Not Found",
    "details": [
        {
            "errorDetail": {
                "attributeName": "device-id",
                "reason": "Not Found"
            }
        }
    ]
}
```

##### Elavon Cloud Payments Interface error

If Elavon Cloud Payments Interface returns the error, the response contains an **errors** object containing a **details** object with additional details.
```

```
###### 404 Not Found (Device-ID invalid, from Elavon Cloud Payments Interface)

```json
{
    "errors": {
        "code": "404.0809.0105",
        "message": "Resource no longer exists",
        "details": [
            {
                "attributeName": "device-id",
                "reason": "Not Found"
            }
        ]
    }
}
```

```
###### 401 Unauthorized (Invalid Token, from Elavon Cloud Payments Interface)

```json
{
    "errors": {
        "code": "401.0809.0101",
        "message": "Authentication failed. You are unauthorized for this resource",
        "details": [
            {
                "attributeName": "Unauthorized",
                "reason": "Unauthorized"
            }
        ]
    }
}
```


Canceling a transaction

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

Overview

Get started

Integration overview

Requests and responses

Device operations

Processing payments

Payment methods

Transaction flows

Creating a transaction

Non-financial messages

API reference

Transaction API Reference

Industry-specific examples

Retail

Lodging

Restaurant and service

eCommerce

Release notes