Getting Started

Getting Started provides the information you need to connect to our demo environment and begin testing your application.

Typical Boarding Implementations

Each API implementation is customized to your needs. Partners implement one of the following flows through the customer application and boarding process. Depending on your existing UI and document signing capabilities, one of these flows will work best for you.

Guided Flow

Integrate in the shortest time (4 to 8 weeks) and with the least effort. Your merchant customers are boarded using:

  • Elavon’s documentation and signing UI
  • Partner branded customer email notifications generated and sent by Elavon
  • Includes functionality for Group Applications (one signature for multiple locations)
  • Supports multiple e-signers
  • Partner can receive email or API push notifications of status

Guided Flow Operations

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

Managed (Stateful) Flow

With a little more effort, integrate a seamless boarding experience within your own customer-facing environment using:

  • Elavon’s documentation and signing API
  • Partner is responsible for UI, flow, presenting application status, and communication with the customer
  • Supports multiple e-signers

Managed Flow Operations

  • Create Document Packet - createdocumentpacket
  • Check Document Signer Status - checkdocumentsignerstatus
  • Refresh Signer User Sessions - refreshsignerusersessions
  • Get Unsigned Packet - getunsignedpacket
  • Get Quiz - getquiz (NA only)
  • Answer Quiz - answerquiz (NA only)
  • Get Signed Packet - getsignedpacket
  • Board application - board
  • Upload Documents - uploaddocuments
  • Board Status - boardstatus

Unassisted (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) to be signed
  • Partner's document signing and PDF regeneration
  • Partner is responsible for UI, flow, presenting application status, and communication with the customer

Stateless Flow Operations

  • Get Quiz - getquiz (NA only)
  • Answer Quiz - answerquiz (NA only)
  • Get a list of all documents - listdocuments
  • Retrieve documents - getdocuments
  • Credit Check - creditcheck (EU Only)
  • Board application - board
  • Upload Documents - uploaddocuments
  • Check Board Status - boardstatus

Pre-requisites

If you've already spoken with an Elavon representative and have an assigned Solutions Engineer, contact them to request an account and credentials.

If you are ready to begin but have not yet spoken to an Elavon representative, visit Contact Us open_in_new to get started.

URLs and Credentials

Once you've received your account and credentials, you can connect to our Demo Environment open_in_new to view API data models and perform high-level structural data validation.

After initial testing in the demo environment, the Certification Environment open_in_new is used to run certification tests and resolve errors so your applications board as expected.

When your application passes all certification tests, you will receive production credentials and move to Production open_in_new.

Using Swagger

Swagger open_in_new is an online portal used to access the most recent API requests and responses that pertain to Elavon's eBoarding Partner API.

Use your API username and password to access Swagger in these environments:

Navigating Swagger

Once you are logged into Swagger, use CTRL+F or scroll to search for API operations.

Click on an API operation to open it and see its parameters. Click on it again to close it.

For example, clicking the POST button next to /v{versionNumber}/boardstatus opens the boarding status operation.

From here, you can toggle between two views--Model and Example Value, which are located in the middle of the screen in the body section.

Example Value appears first by default.

The Model provides descriptions of each variable. You can expand the data model by clicking the caret symbols.

You can tell which view you're currently in by looking at the view's name; the active view is in bold.

Click Example Value to return to the sample code view.

error_outline

note

Due to the way software tools such as Swagger and Postman render the eBoarding API reference, example data may not be visible. When in doubt, refer to the eBoarding API Reference for sample data.

Using Postman

Although this online guide is a good way to get a high level understanding of how our eBoarding APIs work, when you're ready to start playing with real data and testing our APIs, we recommend downloading Postman open_in_new.

Please reach out to your Elavon Relationship Manager. See Contact Us open_in_new to receive API credentials and import our Postman Collections.