eBoarding Partner API Overview
The eBoarding Partner API automates the merchant underwriting and on-boarding process, significantly reducing the time between signing a contract and processing transactions to just a few hours.
The Boarding APIs provide partners a way to board new merchants to Elavon, so that those merchants may begin processing payment transactions online or via point-of-sale (POS) terminals.
If this is your first time here, please see Prerequisites and Tools for more information on how to get started.
Features
- send customer communication emails
- board applications
- get push notifications for application status and/or signing status
- provide approval status
- retrieve device setup information to program your own equipment
- ship equipment to merchant (after application has been approved)
- provide e-commerce setup information (after application has been approved)
Workflow
- A merchant fills out a payment processing application using the partner UI.
- Partner UI interfaces to Elavon’s eBoarding Partner API (PAPI).
- Elavon’s eBoarding PAPI interfaces with Elavon Boarding to run a credit check and evaluate boarding application for approval.
- After approval, the merchant will be eligible for payment processing services via Point of Sale terminals, mobile software, and/or online e-commerce payment transactions.
Each eBoarding API implementation is customized to your needs. Depending on your existing UI and document signing capabilities, one flow will work best for boarding your customers.
For more information on specific operations for each flow, see Integration by Flow Type.
| Type of Integration | Comparison Highlights |
|---|---|
| Guided Flow | - shortest integration time (4 to 8 weeks) - easiest to implement - uses Elavon’s documentation and signing UI - Elavon generates and sends partner-branded customer email notifications - supports group applications (one signature for multiple locations), multiple e-signers, and push notifications for application signing and submission status |
| Managed (Stateful) Flow | - integrate with a little more effort - uses Elavon’s documentation and signing API - Partner is responsible for UI, flow, presenting application status, and customer communications -supports multiple e-signers and push notifications for application signing and submission status |
| Unassisted (Stateless) Flow | - can only be used by partners that have the ability to receive real-time dynamically generated PDF or HTML documentation and get it signed prior to boarding the application - uses Elavon’s API to generate the PDF/HTML documentation to be signed - partner is responsible for document-signing UI, PDF regeneration, flow, presenting application status, and customer communications - supports push notifications only for application submission status |
Example Use Cases
Guided Flow Partner
The partner already has a user interface (UI) to collect new merchant data, such as business name, principal owner information, etc. and what type of payment processing point-of-sale (POS) equipment and/or e-commerce desired capabilities, but would like Elavon software to send emails to the merchant to present the merchant agreement, collect the e-signature, submit the application to Elavon, and provide a method to check application status.
Managed (Stateful) Flow Partner
The partner already has a user interface (UI) to collect new merchant data and what type of payment processing point-of-sale (POS) equipment and/or e-commerce desired capabilities, but would prefer to control communication with the merchant and only use Elavon software for generating the merchant agreement, collecting the e-signature, generating the signed agreement, and submitting the application to Elavon.
Unassisted (Stateless) Flow Partner
The partner already has a user interface (UI) to collect new merchant data, type of payment processing point-of-sale (POS) equipment and/or e-commerce desired capabilities, and has the ability to get the Elavon-generated HTML or PDF agreement signed and regenerated and submitted back to Elavon.
eBoarding UI (SAT) Flow Partner
The partner does not have their own team of software developers and instead wants to use Elavon’s web-based tools to submit merchant applications. In this case, the partner should open_in_newcontact an Elavon representativeLink opens new window.
Requirements
Partners must contact their Elavon Solutions Engineer to request an account and credentials. Proper authentication (basic or Oauth2) must be used to access Elavon APIs.
If you are ready to begin but have not yet spoken to an Elavon representative, visit open_in_newContact UsLink opens new window to get started.