eBoarding Overview

Page Updated: September 30, 2020.

Our Partner eBoarding API facilitates a digital boarding experience. It benefits from Elavon's powerful underwriting and Anti Money Laundering (AML) screening capabilities. You can board one or more merchant customers in minutes instead of days.

Documentation

Our Representatives and Solutions Engineers will guide you through each Step of your chosen implementation. These pages offer an overview of our eBoarding API's global capability and settings.

Consult the API Reference for technical specifications.
Operations specific to European (EU) or North American (NA) implementations are clearly labelled.

Note: Our eBoarding API documentation is mirrored in the EU and NA regions for global use. For ease of reference when implementing the API in NA, you can visit the North American Developer Portal.

Important. We update our eBoarding API and documentation frequently. Printed documentation is valid only on the day of printing.

Requirements

To protect the private and secure nature of the data we share, you must be an Elavon Partner to use the eBoarding API.

Our new Partners can usually start eBoarding customers within 4 to 12 weeks depending on which API flow you implement.

Learn more Get In Touch

Choose What's Right for You

You can board your merchant customers in only a few steps and typically using either a Guided or Managed Flow. Our Partnership Team will guide you on which flow meets your needs.

Guided Flow

Integrate in the shortest time and with the least effort. You can be up and running using the Guided Flow in as little as 4 to 8 weeks.

Your merchant customers are boarded using:

Elavon’s documentation and signing UI
Elavon-branded customer email notifications

List of Guided Flow Operations:

Create a Group Document Packet - creategroupdocumentpacket
Add a Document to the Group Packet - appendgroupdocumentpacket
Update a Document Packet - updatedocumentpacket
Delete a Document Packet - deletedocumentpacket
Delete a Group Document Packet - deletegroupdocumentpacket
Execute a Group Document Packet – executegroupdocumentpacket

Follow these steps to get up and running in as little as 4 to 8 weeks:

Download the eBoarding API Guided Flow PDF (358 KB)

Managed Flow

With a little more effort, you can be up and running using the Managed Flow in as little as 8 to 12 weeks.

Integrate a seamless boarding experience within your own customer-facing environment using:

Elavon’s documentation and signing API
Your own UI, flow status, notifications, and communications

List of Managed Flow operations:

Create a Document Packet - createdocumentpacket
Check Document Signer Status - checkdocumentsignerstatus
Refresh Signer's User Sessions - refreshsignerusersessions
Get an Unsigned Packet - getunsignedpacket
Get a Signed Packet - getsignedpacket
Board the application - board
Upload Documents - uploaddocuments
Check the Board Status – boardstatus

Follow these steps to get up and running in as little as 8 to 12 weeks:

Download the eBoarding API Managed Flow PDF (347 KB).

Stateless Flow

This flow may only be used by partners that have the capability to receive real-time dynamically generated PDF or HTML documentation and get it signed prior to boarding the application. Integrate using:

Elavon's API to generate the PDF (or HTML) documentation to be signed
Your own document signing and PDF regeneration
Your own UI, flow status, notifications, and communications

List of Stateless Flow operations:

Get a list of all documents - listdocuments
Retrieve documents - getdocuments
Perform a Credit Check - creditcheck (EU Only)
Board the application - board
Upload Documents - uploaddocuments
Check the Board Status - boardstatus

Downloads

The following downloads are available:

The latest YAML file is available to download from the API Reference.

Why Choose Elavon?

Elavon offers its services as your acquirer. We handle your merchant customers’ payment transactions from the card holder to the payment gateway, and on to your customer’s bank including:

Authorisation
Authentication
Withdrawal
Placement
Settlement
Currency Conversion

As your Partner, our eBoarding API enables you to quickly board your merchant customers onto your system using Payment Card Industry (PCI) Data Security Standard (DSS) compliant procedures including for:

Terms of Service and Privacy Policy
Identity and credit checking
Anti-Money Laundering (AML) screening
Underwriting
Document authoring, signing, and archiving

Elavon supports a full range of major card types, card schemes, and payment methods. Your merchant customers can take transactions across continents in over 120 local currencies. Add our optional Dynamic Currency Conversion (DCC) for the optimal merchant and cardholder experience.

About Elavon

We pair our commitment to innovation with data security and financial stability. We design our specialized solutions to always meet the unique needs of your industry.

We are a leading payment-processing solutions provider. We deliver the highest standards of service and technology to every customer. Our work has earned us recognition and accolades from across the industry landscape.

Backed by the strength of U.S. Bank, we have 25 years’ experience. We've helped over one million customers grow their business through payments.

Our solutions:

Are flexible, secure and innovative.
Help businesses attract and keep customers.
Develop partner relationships, process payments, and simplify operations.

We are the leading provider for airlines and a top-five provider for hospitality, healthcare, retail, and public sector education. We process more than five billion transactions valued at nearly $450 billion around the World each year.