Merchant Onboarding API
What is the Merchant Onboarding API?
The Merchant Onboarding API offers Payment Service Providers and E-commerce Platforms the ability to provision Riverty systems, so Riverty Payment Methods become available for their merchants. Use of the API requires configuration by Riverty and access keys. For more information on this, contact your Riverty Account manager.
New merchant and shop process: post /merchants
To add a new merchant, 4 objects are involved
- Merchant: Legal name, company registration, primary contact and details of the company
- Shop: Trade name, VAT number, URL, industry code, contact persons, market country and shop details
- Contract: Identification of the contract between Partner and Riverty
- Product: The requested Payment Method
Add shop to an existing merchant: post /shop
To add a new shop, 3 objects are involved and the ID of the merchant.
- Shop: Trade name, VAT number, URL, industry code, contact persons, market country and shop details
- Contract: Identification of the contract between Partner and Riverty
- Product: The requested Payment Method
Technical API description
The Swagger description of the Merchant Onboarding API can be found here: onboarding API documentation
Process
The onboarding process is the same for both creating a new Merchant / Shop as well as adding a shop. It works a-synchronously in two steps:
Step 1:
The Partner sends in Merchant, Shop, Contract and Product details. The onboarding API will validate the request and start the onboarding process. If the validation fails, feedback will be given.
Step 2:
The test API keys will become available via the get credentials endpoint. With the keys the merchant can start testing. If the Partner has a M-Level contract, the production keys will also be available in the same timeframe.
Depending on the type of connection, the response time is as follows:
Test keys | Live keys | |
---|---|---|
M-Level PSP contract | Within 5 minutes | Within 5 minutes |
Other type of contract | Within 5 minutes | Within 3 working days* |
*conditions apply