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.

The principal section captures details of the individual
responsible for card processing services on behalf of the merchant's
business.

## principal elements

**Top Level** - Various identifiers regarding the principal's
properties.

| Element | Description |
|------------------|-------------------------------|
| responsibleParty | Determines who is in charge of the day-to-day business operations. Boolean true if yes, false if no. |
| positions | Required. Boolean map denoting the positions that an individual holds in the applying company. *Beneficial Ownership* = 25% or greater ownership (all Beneficial Owners must be listed and include required information: name, address, ID Number, and date of birth.) *Authorized Signer* can be an authorized signer or if ownership is less than 25% Boolean true if yes, false/not present if no. Populated from a list of positions that can be found in the eBoarding OpenAPI. |
| ownershipPct | Required if there is an Intermediary Owner. Percentage an individual owns of the business. Can be 0% for principal, all additional shareholders should be at least 25%. |
| primaryNationality | Required. Country of principal's primary nationality. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| secondaryNationality | Optional. Country of principal's secondary nationality. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| residingCountry | The principal's country of residence. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| signingPersonalGuarantee | Required. Used to determine if this person should be regarded as being expected to sign a personal guarantee in addition to their normal documents. **NOT required for Sole Proprietors.** Boolean true if yes, false for no. Default to 'yes' for Sole Proprietors. |
| signingAgreement | Required. Boolean denoting whether a person is signing the application's agreement. Boolean true if yes, false for no. |
| usPerson | Boolean denoting whether a person is a U.S. citizen. Boolean true if yes, false for no. It is derived from primaryNationality and secondaryNationality if nothing is provided in this field. |
| title | Required only in cases where titleType is **OTHER**. Free text description of a person's title, to be used when the correct option is not provided by titleType. |
| titleType | Required. The person's job title. Populated from a :magic-link[list of accepted titles]{id="element-code-tables" anchor="titletype"}. |

**name** - A recurring section that identifies individuals to eBoarding Partner API.

| Element | Description |
|---------------|----------------------------------------|
| firstName | Required. An individual's first name. |
| middleName | Optional. An individual's middle name. |
| lastName | Required. An individual's last name. |

**contactInfo** - Includes details for identifying how to contact
the individual identified in this nested section, such as contacting the
principal or additional shareholders.

**address** - Refers to an individual's mailing address, either
primary residence or business address. This data can be used to send
printed materials to anyone being identified.

| Element | Description |
|---------------|----------------------------------------|
| streetName | Required. Line one of individual's address. |
| lineTwo | Optional. Line two of individual's address. |
| state | Required. State/Province of individual's address. Populated from a :magic-link[list of states, territories, and provinces]{id="element-code-tables" anchor="states-territories-and-provinces"}. |
| city | Required. The city of an individual. |
| postcode | Required. The zip/postal code of an individual. |
| country | Required. The country of an individual. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| classification | Required for business, principal, and additional shareholder addresses. This field denotes whether the address is business (`BUSINESS_STREET_ADDRESS`) or residential (`PHYSICAL_RESIDENTIAL_ADDRESS`). |

**phone** - The phone section contains all elements of a phone
number, including the international code which is populated by enums
found in the reference section.

| Element | Description |
|---------------|-------------------------------------|
| intlCode | International Dialing Code used before a telephone number to call a specific country. Populated from a :magic-link[list of International phone codes]{id="element-code-tables" anchor="international-phone-codes"}. |
| areaCode | Required. The area code within a country. |
| number | Required. An individual's phone number. |

**emailAddress** - Collecting this data ensures that contact information
is complete; use the email address of the principal, contact, or
additionalShareholders to send bills, updates, and any other
correspondence that is time sensitive.

| Element | Description |
|--------------|--------------------------------------|
| emailAddress | Required for all signers, including the principal. Applicant's email address.

**dob** - Collects the date of birth of an individual or additional shareholders. This is generally required unless the signer falls under AML exception.

:::::notice{note}

This field is optional for principals when the Customer Identification Program (CIP) exemption type (`exemptionType` field located in `businessInfo`) is chosen.
:::::


| Element | Description |
|----------------|--------------------------------------------|
| year | Required. The year an individual was born. |
| month | Required. The month an individual was born. The month is encoded using the first three letters of the month. |
| day | Required. An individual's birthdate. |

**id** - The id section identifies which document validates the identity of the applicant, for example: SSN, ITIN, government issued id. This information is generally required unless the signer falls under AML exception.

| Element | Description |
|--------------|----------------------------------------------|
| idType | Required. The type of identification used, such as passport, driver's license, etc. Populated from a :magic-link[list of accepted ID types]{id="element-code-tables" anchor="idtype"}. |
| idNumber | Required. The number of the identification used. |
| | **expiryDate/issueDate** |
| year | Required. The year that the ID defined above expires/was issued. |
| month | Required. The month that the ID defined above expires/was issued. The month is encoded using the first three letters of the month. |
| day | Required. The day that the ID defined above expires/was issued. |

**documentaryInfo**

Principal(s) information can be validated through documentary or non-documentary means. If documentary (Sales_Team), the information from that document must be provided. If non-documentary, the principal(s) are validated internally. This information is generally required unless the signer falls under AML exception.

| Element | Description |
|--------------|-----------------------------------------|
| documentary | Required. This element describes whether documentary information is given. Boolean true for yes, false for no. If true, additional fields (`documentaryIssuer`, `documentaryType`, `documentaryVerifier`) are required. |
| documentaryIssuer | Required. Country of document issuance. Use ISO 3166-1 alpha-3 standard (3 letter country code). |
| documentaryType | Required. Type of document. Populated from the :magic-link[documentaryType list]{id="element-code-tables" anchor="documentarytype"}. |
| documentaryVerifier | Required. Verifier of document, either the sales team (`SALES_TEAM`) or unverified (`NOT_VERIFIED`). |
| idNumber | Required. Identifier of document. |
| issuingState | Required. State/Province of document issuance. Populated from a :magic-link[list of states, territories, and provinces]{id="element-code-tables" anchor="states-territories-and-provinces"}. |
| | **expiryDate/issueDate** |
| year | Required. The year that the ID defined above expires/was issued. |
| month | Required. The month that the ID defined above expires/was issued. The month is encoded using the first three letters of the month. |
| day | Required. The day the ID defined above expires/was issued. |

**alternateAddressInfo** 

Optional; specifies alternate verification of document.

| Element | Description |
|---------------|--------------------------------------------|
| documentNeeded | Required. Describes if alternative information is needed or not. Boolean true for yes, false for no. |
| documentVerified | Required if an `alternateAddressDocumentType` is given. Describes if a submitted document is verified. Boolean true for yes, false for no. |
| alternateAddressDocumentType | Optional. Type of document given for address verification, such as a bank statement (`BANK_STATEMENT`), utility bill (`UTILITY_BILL`), or other (`OTHER`) valid form of documentation. |

principal

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