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. Typically our partners implement one of two flows through the customer application and boarding process.

Implementation

Description

Guided Flow

Integrate in the shortest time 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)
  • Partner can receive email or API push notifications of status

Guided Flow Operations:

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

 

Managed (Stateful Document) 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 responsible for UI, flow, application status, and communication with the customer

Managed Flow Operations:

  • Create Document Packet - createdocumentpacket
  • Check Document Signer Status - checkdocumentsignerstatus
  • Refresh Signer User Sessions - refreshsignerusersessions
  • Get Unsigned Packet - getunsignedpacket
  • Get Quiz - getquiz
  • Answer Quiz - answerquiz
  • Get Signed Packet - getsignedpacket
  • Board - board
  • Upload Documents - uploaddocuments
  • 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, please contact us to get started.

URLs and Credentials

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

After initial testing in the demo environment, the certification environment 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.

Using Swagger

Swagger 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

Postman can be used as an alternative to Swagger for viewing the eBoarding API Reference and testing API calls.

To use Postman:

  1. Download and install Postman.
  2. Sign in to Postman.
  3. In your browser, open the eBoarding API Reference .
  4. From the eBoarding API Reference page, right-click on Download and select "Copy Link Address."
  5. Go back to Postman and click Import.
  6. From here, choose "Import from Link" and paste the link address you just copied (ie. the eBoarding API Reference).
  7. In the Import dialog box, confirm that the import is an API and that Postman should generate a Postman collection.
  8. A collection is created and named using the API title value by default (example: "eBoarding Global Application"). You can rename the collection by clicking the menu icon (an ellipses) and selecting "Rename" (example: "eBoarding Postman API").
  9. To view a summary of the file in a webpage, open the collections tab, click the expand icon to see the current collection, then click "View in web."