Our Onboarding API simplifies the integration process, making it quick and easy for merchants to get started. With this tool, you can expedite the digital registration process, enabling your merchants to be up and running in no time.
In our solution, a Sponsored Merchant stands for retailers or service providers on your platform.
In order to streamline the onboarding process for these sponsored merchants on your platform, you can create a tailored user interface (UI) to collect merchants’ data and subsequently submit it to our API.
In this guide, you will find an explanation of the entire process of onboarding a sponsored merchant.
Note that your sponsored merchants will be subject to thorough onboarding evaluations, encompassing KYC verifications, unless specific agreements have been made during your own onboarding.
If they are not required to undergo KYC at this stage, the onboarding process via API will proceed without any interruptions, and the Sponsored Merchants will be generated.
If the sponsored merchants are required to undergo KYC diligences, we will conduct asynchronous diligences and provide you with the results via Webhook.
Merchant Creation and Its Substructures
By following these instructions, you will be able to onboard a new sponsored merchant by creating the full merchant structure — including the shop, payment methods and terminals — in a single request: https://www.docs.pay.sibs.com/onboarding-api/merchant/
After this request, the merchant will receive onboarding credentials and may begin the integration process for payment acceptance.
You will receive a webhook confirming the success of the operation or, in case of failure, a notification detailing the cause of the error, as described on the following page: https://www.docs.pay.sibs.com/onboarding-api/merchant/#error-handling
Managing Substructures
After the merchant is created, you may need to add, edit, or cancel additional shops, payment methods or terminals.
In such cases:
- To manage shops or payment methods, please use the APIs described here: https://www.docs.pay.sibs.com/onboarding-api/shop/
- To manage terminals, please refer to the following documentation: https://www.docs.pay.sibs.com/onboarding-api/terminal/
Before you start
Ensure that during the onboarding process your Account Manager shared the necessary credentials with you:
- Client ID
- Terminal Bearer Token
Once you have these, you will be able to initiate the onboarding process via the API.
Keep your credentials confidential to maintain security of your transactions.