This is the reference for the Boarding API. Here you will find detailed information about each resource of the API. Each method below expresses the necessary information to successfully utilize the indicated HTTP verb with the resource. Example request and response are available to each method called if the resource support this. For further assistance, contact a representative of our API support by emailing [email protected]

Base URL: https://api.mxisoagent.com/boarding/v2
Sandbox URL: https://sandbox.api.mxisoagent.com/boarding/v2

Merchant Boarding

There are two ways of boarding a merchant. There is Traditional Merchant boarding and QuickStart Merchant boarding. Both ways call the same URL and use the same properties.

The Traditional merchant boarding process is used to submit all of the same criteria that would be found on a full merchant application. In most cases, this is used when an Agent has developed an internal CRM system. You do not need to be "approved" or have your portfolio setup in any special way in order to submit merchants this way.

The QuickStart merchant boarding process allows you to submit a minimal amount of criteria (around 18 - 20 fields) for the merchant to be submitted and setup. The approval process and setup is instant which allows the merchant to process transactions just about instantly. Agent Offices must be given permission to board merchants on the QuickStart program. Merchants boarded on the QuickStart program are always boarded to TSYS.