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

The process to send a transaction is the same for both card-present and card-not-present messages (the only difference being the URI that messages are sent to). 

For card-present messages (i.e., Authorizations, Sales and Returns/Refunds), a request is sent to Elavon Cloud Payments Interface via HTTPS POST, specifying the Simplify device to be used and other parameters.

The subsequent flow of information varies depending on whether the transaction is *synchronous* or *asynchronous*.

## Synchronous transactions

Transactions are processed as synchronous transactions if the responseChannelType is SYNCHRONOUS in the message request object. The message results are returned as part of the JSON body in the immediate response.

The steps for a synchronous transaction are:

1.  The **merchant** initiates a transaction from the POS.

2.  The POS's **integrator** sends a message request to:

    1.  `/devices/{device-id}/message` for card-present asynchronous messages  
        OR  
        `/gateways/message` for card-not-present (token) messages

    2.  The request JSON contains the messageId, responseChannelType, responseChannel, messageType and message values.

    3.  At this time, the only valid value for messageType is `application/vnd.elavon-transaction-message-b.v1+json`

3.  If card-present (CP), the **payment entry device** (such as a Simplify PIN pad) processes the transaction. Otherwise, if card-not-present/token (CNP), Fusebox processes the transaction.

4.  When the transaction is completed, **Elavon Cloud Payments Interface** returns the response message in the original HTTP response as 200 OK.

## Asynchronous transactions

If an Integrator identifies WEBHOOK as the responseChannelType and the responseChannel object contains a valid, registered *webhook URL*, then 

-   Transactions are processed as **asynchronous** transactions.

-   The HTTPS request response will be:

    -   202 (acknowledging the request has been received and is being processed)
	    OR
        An error response (if the request is unable to be processed)

The steps for an asynchronous transaction are:

1.  The **merchant** initiates a transaction from the POS.

2.  The POS's **integrator** sends a message request to:

    -   `/devices/{device-id}/message` for card-present asynchronous messages  
        OR  
        `/gateways/message` for card-not-present (token) messages

3.  The message JSON contains the messageId, responseChannelType, responseChannel, messageType and message values.

    1.  At this time, the only valid value for messageType is `application/vnd.elavon-transaction-message-b.v1+json`.

    2.  Elavon Cloud Payments Interface returns HTTP response 202 - request received.

    3.  If the message is for card-present (CP), the payment entry device (such as Simplify) processes the transaction.

    4.  Otherwise, the card-not-present/token (CNP) message gets processed by Fusebox.

4.  When the transaction is completed, **Elavon Cloud Payments Interface** returns the message response to the *webhook URL*.

### Integrator webhook requirements

#### Webhook URL endpoint

When using the asynchronous transaction method, a **webhook** endpoint **must** be setup in the Integrator's environment.

This endpoint's URL will be sent in the transaction request and used by Elavon Cloud Payments Interface for posting responses back during the transaction flow.

An example webhook URL might look like: `https://myintegrator.io/payment/webhook/`

#### Security requirements

The security requirements for posting data to the integrator's webhook URL are:

1.  A webhook URL with a valid SSL certificate. 

    -   Elavon Cloud Payments Interface only supports posting to a webhook with valid certificates. 
	
    -   No self-signed certificates are allowed.

2.  Elavon Cloud Payments Interface only supports posting to a webhook with either **Basic Authentication** or **OAuth 2.0** implemented as the authentication method. 

#### Authentication credentials

Authentication credentials must be accepted as header information.

##### Example header (Basic Authentication)

`Authorization: Basic eyJhbGciOiJSUzI1...`

##### Example header (Bearer Authentication)

`Authorization: Bearer YmlsbGVycy1lbG...`

#### Basic authentication example

##### Elavon Cloud Payments Interface POST response to webhook with Basic Authentication
```
curl -X POST "https://myintegrator.io/payment/webhook/"
-H "Content-Type: application/json"
-H "Authorization: Basic N5GhOWXC1MDYtYzY0Zi0NiLWRkNjFjYjQxN2I1Ng=="
-d "message: Test"
```

##### OAuth 2 Authentication

Requires the Token URI, Client ID, Client secret and grant\_type that are needed to obtain a token. This token will be used to authenticate to the webhook URL. 

**Note:** Token server should be able to accept authorization in the header request as the Base 64 encoded client ID and Client Secret.

#### OAuth example

##### Elavon Cloud Payments Interface request token from integrator
```
curl -X POST "https://myintegrator.io/payment/webhook/auth/token"
-H "Content-Type: application/x-www-form-urlencoded"
-H "Authorization: Basic N5GhOWXC1MDYtYzY0Zi0NiLWRkNjFjYjQxN2I1Ng=="
-d "grant\_type=client\_credentials"
```

##### Integrator's response from token request
```
"access\_token": "ey0iGhOWXC1MDYtYzY0Zi0NiLWRkNjFjYjQxN2I1Ng=="
"token\_type": "bearer",
"expires\_in": 899,
```

##### Elavon Cloud Payments Interface POST response to webhook using token
```
curl -X POST "https://myintegrator.io/payment/webhook/"
-H "Content-Type: application/json"
-H "Authorization: Bearer ey0iGhOWXC1MDYtYzY0Zi0NiLWRkNjFjYjQxN2I1Ng=="
-d "message: Test"
```


Transaction flows

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

Creating a transaction

Canceling a transaction

Non-financial messages

API reference

Transaction API Reference

Industry-specific examples

Retail

Lodging

Restaurant and service

eCommerce

Release notes