Skip to main content
This page is for PSPs. If you collect only for your own business, skip it — you have nothing to add.
As a PSP you collect on behalf of other businesses. Each one is onboarded as a sub-merchant, and gets its own merchant ID that you pass on every API call made for it.
“Merchant” is the API’s word, not a description. Whatever you collect for is a sub-merchant — a university, a hospital, a travel operator. The dashboard tab and the API field both say merchant, so that is the word this guide uses.

​
Add one from the dashboard

  1. Go to the merchant dashboard.
  2. Open the Merchants tab.
  3. Click Add Merchant.
Add Merchant button in the Merchants tab
  1. Fill in their details.
Sub-merchant details form
  1. Click Add.
In sandbox the sub-merchant is activated within seconds and you can start collecting for them straight away.

​
Then use their merchant ID

Once activated you get a merchant ID. Send it as X-Merchant-ID on every call you make for that sub-merchant. You can also do all of this over the API rather than the dashboard:

Create Merchant

Onboard a sub-merchant programmatically.

List & Get Merchant

Fetch the sub-merchants you have onboarded, and their status.
In production a sub-merchant must be approved before it can collect. Watch for the Merchant Approved webhook.