Boarding Merchants - API

Introduction

In this section, you will learn about the onboarding process using the Boarding API and the sequence of steps required to successfully board a merchant.

Note: As of September 2021, our documentation now refers to the new boarding API at boarding/v1. For references to the old boarding API at merchant/v2, please change from v2 to v1 version in the top right corner of the page

Prerequisites

• Partner account with access to MX Connect
• Use of the updated boarding API version boarding/v1
• Basic understanding of the boarding process and its components
  • Universal Account Record (UAR)
  • Location, Entity, and Account Objects
• Completion of authentication using a valid JWT to authorize API calls

Limitations

• The older merchant/v2 API is deprecated and should not be used
• Only the boarding/v1 API version supports the current boarding process
• The boarding flow must follow the required sequence
  • Create Universal Account Record (UAR)
  • Update Location
  • Update Entity
  • Update Account
  • Finalize Account
• Lack of completion in any step will prevent merchant onboarding

What is Boarding?

In our company as an ISV/ISO, you will want to sign up one or as many merchants under your portfolio. This API will show you how to board many merchants so that they can start processing as quickly as possible. There are a few steps that need to be taken in order to start the boarding process.

1. Create a UAR
2. Updating the Location
3. Update the Entity
4. Updating the Account
5. Finalizing the Account

We will be breaking down each of the above in simple terms!