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

Best practices for eBoarding refer to rules that are applied to boarding applications, so that data input by the user meets minimum requirements and will be in a readable format for downstream systems. 

## Character normalization
Wherever Partner API (PAPI) operations have text strings as input fields, be aware that prior to sending data to downstream Elavon systems, the following character conversion rules are applied:

Non-English characters are converted into their closest English counterpart according to the Java Normalizer of `Normalizer.normalize(str, Form.NFD).replaceAll(\\p{InCombiningDiacriticalMarks}+, "");`

**Example:** Ú gets converted to U. Additionally, characters Ł and ł are converted to L and l, respectively.

All other characters that are not a letter, number, or whitespace are removed "[^a-zA-Z0-9 ]".

Any reports or data coming back from Elavon will reflect this character normalization. 

## Basic rules


- If `primaryNationality` is `USA`, then usPerson = true; if `primaryNationality` is not `USA`, then usPerson = false.

- For US applications, supplementary `documentaryInfo` is not needed for principal.
    ``` 
    "documentaryInfo" : {
          "documentary" : false,
          "documentaryVerifier" : "NOT_VERIFIED"
    ```
- For all applications with the exception of `SOLE_TRADER` accounts, at least one principal must be listed as a `responsibleParty`.

- For all `ownershipTypes` except for `SOLE_TRADER`, verifications fields in `businessInfo` section need to be filled out.

    - If documentary = false, then do not send `legalStatus`.

    - Non-documentary types should never be sent for `documentaryType` (i.e `SECRETARY_OF_STATE_WEBSITE`, etc). 
    - When documentary = true, `legalStatus` should be same as `documentType`.

    - If verification is via on-site inspection, then documentary is false and you would include `sitePersonMet` in the call. `legalStatus` is optional in this scenario:
      ```
        "verifications" : {
          "LEGAL" : {
            "documentary" : false,
            "sitePersonMet" : "Test Merchant",
            "issueDate" : { },
            "expiryDate" : { }
          }
        }
      ```
  


- Positions is determined by `ownershipPct` with exception of `SOLE_TRADER` accounts. `SOLE_TRADER` account will always be "SOLE_PROP" : true.

    - If `ownershipPct` is 24 or less, then:
      ``` 
      "positions" : {
          "AUTHORIZED_SIGNER" : true
      ```

    - If `ownershipPct` is 25 or greater, then:
      ```
      "positions" : {
          "BENEFICIAL_OWNER" : true
      ```

## OwnershipType rules

### Business & legal fields

`SOLE_TRADER`
- `taxID` is generally copied from the principal SSN but, can be different. 

- `verifications` is left empty as it should not be provided for Sole Proprietorships. 
```
  "ownershipType" : "SOLE_TRADER",
        "taxID" : "*********",
        "communicationLanguage" : "en",
        "posLanguage" : "en",
        "associationCodes" : [ ],
        "signDate" : { },
        "pciInfo" : { },
        "verifications" : { }
      },
```

`LIMITED_COMPANY`
- LLCs must also include the `taxClassType` 
``` 
"ownershipType" : "LIMITED_COMPANY",
        "taxID" : "*********",
        "taxClassType" : "CORPORATION",
```

`ESTATE` and `CLUB` (Unincorporated Association)
- Normal rules apply for capturing `businessInfo`

**Beneficial owner exemption status**
- Normal rules apply for capturing `businessInfo`
- `ownerExemptionType` must be captured/sent
```
    "ownershipType" : "CHARITY",
    "taxID" : "*********",
    "productDescription" : "TEST",
    "mccCode" : "8699D",
    "establishmentYear" : "2022",
    "currentOwnershipYears" : "0",
    "currentOwnershipMonths" : "1",
    "communicationLanguage" : "en",
    "posLanguage" : "en",
    "associationCodes" : [ ],
    "signDate" : { },
    "pciInfo" : { },
    "countryOfOrigin" : "USA",
    "ownerExemptionType" : "NON_PROFIT",
    "countryOfPrimaryOperation" : "USA",
```

**CIP exemption**
- Normal rules apply for capturing `businessInfo`
- `exemptionType` must be captured/sent
```
    "ownershipType" : "GOVERNMENT",
    "taxID" : "*********",
    "productDescription" : "TEST",
    "mccCode" : "9399B",
    "establishmentYear" : "2022",
    "currentOwnershipYears" : "0",
    "currentOwnershipMonths" : "1",
    "communicationLanguage" : "en",
    "posLanguage" : "en",
    "associationCodes" : [ ],
    "signDate" : { },
    "pciInfo" : { },
    "countryOfOrigin" : "USA",
    "exemptionType" : "US_STATE_DEPARTMENT",
    "countryOfPrimaryOperation" : "USA",
```


### Principal fields

`SOLE_TRADER`
- `titleType` should be `PROPRIETOR_OR_OWNER` when `ownershipType` is `SOLE_TRADER`
- `signingPersonalGuarantee` : true, should be defaulted for all `SOLE_TRADER` accounts.
- `responsibleParty` line item is not captured or sent for `SOLE_TRADER` accounts.

```
"positions" : {
    "SOLE_PROP" : true
    },
    "ownershipPct" : "100",
    "ids" : [ {
      "idType" : "ID_CARD",
      "idNumber" : "*********",
      "expiryDate" : { }
    } ],
    "titleType" : "PROPRIETOR_OR_OWNER",
    "signingPersonalGuarantee" : true,
    "residingCountry" : "USA",
    "primaryNationality" : "USA",
    "documentaryInfo" : {
      "documentary" : false,
      "documentaryVerifier" : "NOT_VERIFIED"
    },
    "alternateAddressInfo" : {
      "documentNeeded" : false
    },
    "usPerson" : true  
    },
```

`LIMITED_COMPANY`
- Normal rules apply for capturing/sending Principal info.

`ESTATE` and `CLUB` **(Unincorporated Association)**
- ESTATE and CLUB ownershipType are exempt from providing `Ids` fields. `Ids` fields are not required to be captured. 
- `responsibleParty` is defaulted to true. 
- `dob` is still required
```
        "dob" : {
          "year" : 1977,
          "month" : "FEB",
          "day" : 20
        },
        "positions" : {
          "AUTHORIZED_SIGNER" : true
        },
        "ownershipPct" : "0",
        "ids" : [ ],
        "titleType" : "DIRECTOR",
        "signingPersonalGuarantee" : false,
        "responsibleParty" : true,
        "residingCountry" : "USA",
        "primaryNationality" : "USA",
        "alternateAddressInfo" : {
          "documentNeeded" : false
        },
        "usPerson" : true
```
**Example of beneficial owner exemption status**
- `ownershipPct` should be defaulted to 0. `SSN` is still required for eSignature.
```
        "positions" : {
          "AUTHORIZED_SIGNER" : true
        },
        "ownershipPct" : "0",
        "ids" : [ {
          "idType" : "ID_CARD",
          "idNumber" : "*********",
          "expiryDate" : { }
        } ],
        "titleType" : "DIRECTOR",
        "signingPersonalGuarantee" : false,
        "responsibleParty" : true,
        "residingCountry" : "USA",
        "primaryNationality" : "USA",
        "alternateAddressInfo" : {
          "documentNeeded" : false
        },
        "usPerson" : true
```
**Example of CIP exemption**
- `ownershipPct` should be defaulted to 0.
- `responsibleParty` is not captured/sent
```
        "positions" : {
          "AUTHORIZED_SIGNER" : true
        },
        "ownershipPct" : "0",
        "ids" : [ {
          "idType" : "ID_CARD",
          "idNumber" : "*********",
          "expiryDate" : { }
        } ],
        "titleType" : "DIRECTOR",
        "signingPersonalGuarantee" : false,
        "residingCountry" : "USA",
        "primaryNationality" : "USA",
        "alternateAddressInfo" : {
          "documentNeeded" : false
        },
        "usPerson" : true
```

Best practices

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

eBoarding Partner API Overview

Integration by flow type

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

Release notes

2024

2023

2022

2021

2020