A previous version of the Merchant Boarding API (v2 and v2.1) is live currently, however a new enhanced version is in development. The new version suits the requirement where consumers send information in sections before submitting the full payload. The new version of the API expected in Q4 2022.
The current version that is live requires the consumer to send in all information in one payload, as opposed to individual sections.
Please note the API specification may change while it's in development
Boarding merchants to Fiserv systems is a key prerequisite for them to start processing payments. The boarding process sets up a merchant in the appropriate systems and activates the desired services and equipment.
There are several resources which make up a complete merchant application:
- Bank Accounts: these are the bank accounts associated with the merchant for pay-outs (funding) and fees
- Contacts: these are the contacts details used for stores or businesses e.g. shipping, billing, legal. The address used for contacts is always related to the merchant (it's not the personal address of the contact)
- Owners: these are the details about the owners and main beneficiaries of the merchant. Details include ownership percentage and personal contact details which are then used for KYC and AML checks. The address used for owners is always the personal address of the owner
- Stores: these are the physical or online stores where transactions take place. The details captured here serve two main purposes. One is to ensure the store is set up with the right equipment and acquiring offer. Another is to ensure underwriting checks can be carried out effectively
- Businesses: these are the details about the business (name, mcc, bank accounts) and its structure. A parent business can be set up to have child entities to form a hierarchy structure
- Ownership Entities: these are the legal entity details about the merchant, which included the owners
- Merchant Applications: this resource contains the details related to a specific application (status, seller information, documents), and is used to create, update and monitor applications
The following features will be available:
The following resources make up a merchant application:
If this is your first time here, we recommend you do things in the following order:
- Follow our common getting started guide
- Follow the merchant boarding quick start guide
- Dive into the API reference, such as for create a merchant application
The process below splits up the merchant application into individual resources so that the consumer can input information in sections with smaller payloads. Then the whole application is connected together using IDs.
All resources require a merchant application to be created first. Any resources created under a
merchantApplicationIdcan only be used for that application.