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.

Partners can choose to receive push notifications of certain application events. Push notifications are transmitted using the PAPI `notificationStatusRequest` object. Before getting push notifications, end points and authentication must be configured.

## Authentication

In order to receive push notifications, authentication is required in both test and production environments. The following methods for authentication are supported:

- **Token-based authentication:** Partner provides Elavon with the token and URL endpoint.
- **Basic authentication:** Partner provides Elavon with the username, password, and URL endpoint.
- **OAuth2 authentication - password grant:** Partner provides Elavon with the client ID, client Secret, username, password, authentication URL, and URL endpoint.
- **OAuth2 authentication - client credentials grant:** Partner provides Elavon with the client ID, client Secret, authentication URL, and URL endpoint. Partners can also specify a scope parameter which will be passed in the authentication header.

Elavon will need your SSL Certificate in order to send push notifications.

## Types of Push Notifications

The `notificationEvent` property will define the type of event that occurred.

Tell Elavon which push notifications you'd like to receive.

| Push Notifications Schedule | Notification Event Name | Applicable To |
|-----------------------------|-------------------------|---------------|
| Sent when the application's status changes (`INPROGRESS`, `PEND`, `COMPLETE`, `DECLINED`, or `WITHDRAWN`) | BOARDING_STATUS | All Flows |
| Sent when an application is declined because of a low credit score | DECLINE_NEGATIVE_CREDIT | All Flows |
| Sent when an application is declined because the type of business is not supported | DECLINE_BUSINESS_TYPE | All Flows |
| Sent when an application is declined for another reason (e.g. too many chargebacks, etc.) | DECLINE_OTHER_REASON | All Flows |

## Push Notification Structure
The `notificationStatusRequest` object contains the following properties:
- `uniqueId`: Returned for all flows.
- `clientId`: Returned for all flows.
- `packetId`: Returned for Managed flow.
- `correlationId`: Returned for all flows when the original request contains the correlation ID.
- `notificationEvent`: Returned for registered and applicable events. 
- `appStatus`: Returned for Managed flow.
- `messages`: Returned for all flows.
- `signerStatus`: Returned for Managed flow.
- `boardingStatusDetail`: Returned for all flows.
- `chainId`: Returned for all flows, if new chain was requested.
- `terminalIdInfo`: Returned for all flows, if applicable.
- `declineReason`: Returned for all flows, if applicable.

Here is the structure of `notificationStatusRequest`:

```
{
 "type": "object",
 "properties": {
 "uniqueId": {
 "type": "string"
 },
 "clientId": {
 "type": "string"
 },
 "correlationId": {
 "type": "string"
 },
 "groupPacketId": {
 "type": "string"
 },
 "packetId": {
 "type": "string"
 },
 "notificationEvent": {
 "type": "string",
 "enum": [
 "EMAIL_SENT",
 "REGISTRATION_ERROR",
 "REGISTRATION_COMPLETED",
 "SIGNATURE_STATUS",
 "APPLICATION_SUBMITTED",
 "BOARDING_STATUS"
 ]
 },
 "appStatus": {
 "type": "string",
 "enum": [
 "DRAFT",
 "SUBMITTED",
 "COMPLETE",
 "ERROR",
 "WITHDRAWN",
 "DECLINED"
 ]
 },
 "messages": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "signerStatus": {
 "type": "array",
 "items": {
 "type": "object",
 "properties": {
 "signerId": {
 "type": "string"
 },
 "signerStatus": {
 "type": "string",
 "enum": [
 "DRAFT",
 "ACCEPTED",
 "SIGNED",
 "DECLINED",
 "EXPIRED"
 ]
 }
 }
 }
 },
 "boardingStatusDetail": {
 "type": "object",
 "properties": {
 "boardingStatus": {
 "type": "string",
 "enum": [
 "UNKNOWN",
 "COMPLETE",
 "INPROGRESS",
 "DECLINED",
 "WITHDRAWN",
 "ERROR",
 "TIMED_OUT",
 "PEND"
 ]
 },
 "boardingId": {
 "type": "string"
 },
 "merchantId": {
 "type": "string"
 },
 "errorMessages": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "declineReason": {
 "type": "string",
 "enum": [
 "DECLINE_NEGATIVE_CREDIT ",
 "DECLINE_BUSINESS_TYPE ",
 "DECLINE_OTHER_REASON"
 ]
 },
 "pendMessages": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "underwriterNotes": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "underwriterContacts": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 }
 },
 "chainId" : {
 "type": "string"
 },
 "terminalIdInfo" : {
 "type": "object",
 "properties" : {
 "error" : {
 "type" : "string"
 },
 "welcomeUrl" : {
 "type" : "string"
 },
 "virtualId" : {
 "type" : "string"
 },
 "terminalBin" : {
 "type" : "string"
 },
 "terminalIdDataMap": {
 "type": "array",
 "description": "Java map <String,Object> where string is key and object contains terminalId, userId, pin, and errorText.",
 "items": {
 "anyOf": [
 {
 "type": "object",
 "examples": [
 {
 "keyString": [
 {
 "terminalId": "some terminalId",
 "userId": "some userId",
 "pin": "some pin",
 "errorText": "some error text"
 }
 ]
 }
 ],
 "properties": {
 "keyString": {
 "type": "array",
 "description": "An explanation about the purpose of this instance.",
 "items": {
 "anyOf": [
 {
 "type": "object",
 "description": "An explanation about the purpose of this instance.",
 "properties": {
 "terminalId": {
 "type": "string",
 },
 "userId": {
 "type": "string",
 },
 "pin": {
 "type": "string",
 },
 "errorText": {
 "type": "string",
 }
 }
 }
 ]
 }
 }
 }
 }
 ]
 }
 }
 }
 }
 }
}
```

Push Notifications

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

eBoarding Partner API Overview

Integration by flow type

Prerequisites and tools

Boarding process workflows

Main boarding elements

Passing data to board

Principal applicant

Additional shareholders

Contact information

Financial information

Card pricing

Bank account information

Billing

Fees

Payment processing equipment

Dynamic currency conversion (DCC)

Value added services

Third-party signing

Complementary API calls

API reference

Element code tables

Merchant category codes

Boarding timeouts

Push notifications

Best practices

Release notes

2024

2023

2022

2021

2020