Integration: Merchant onboarding API
The first record that needs to be created is of the Account entity type. Once successfully created, you will receive the uP POM Account ID associated with that merchant. You will need this uP POM Account ID to create record on the other entities, such as Contacts, Opportunities, Locations, Products, Banking details and attach Documents to the merchant (i.e., the Account entity).
The uP POM Account ID is a key identifying field within the merchant onboarding API and process only. Once the merchant is approved and processing payments, the merchant’s platform-wide identifier will automatically transition to the uP Account ID variable.
The status of the onboarding of the merchant can be found in the Account entity. As soon as there is an update to the status, you will be informed via webhook.
The record of Contact entity type can be created following the creation of the Account record. There can be several Contacts related to an Account record. All the directors, signatories and UBO's of the merchant (i.e., the Account entity) must be created. A single Contact can be classified as Director, Signatory, UBO, Legal Notice and Regular Contact.
Records in the Opportunity entity can be created following the creation of the merchant (i.e., the Account entity) record. If the merchant operates in different countries, you will need to create multiple Opportunity records. The Opportunity is also required to have Products associated with it.
Products consist of a solution, model, payment Type and payment method; (see Product entity. The record of Product entity type cannot be created, it is read only.
The record of Pricing entity type can be created following the creation of the merchant (i.e., the Account entity) and Opportunity entity records. For each Product selected, there will be at least one Pricing record.
The record of Location entity type can be created following the creation of the merchant (i.e., Account entity) record.
A Location can be either a physical brick-and-mortar store or an e-commerce URL. As such, if your merchant has 2 physical locations and an online URL, you will need to create 3 Location records and attach them to the Account entity for this merchant.
The record of Banking details entity type can be created after the merchant (i.e., Account entity) record has been created.
Below you will find a visualisation of the API workflow in the order that it occurs.
