Merchants · Create a merchant
API reference / Merchants
Create a merchant
POST/api/v1/merchantsno app scope
Creates a merchant in your organisation. Partner platforms usually use Set up a business, which also links existing accounts and returns keys.
Body
namestringrequired
Business name.
emailstringrequired
Business email.
usernamestring
Its handle on Inkress, and its Client-Id (m-<username>). If you leave it out, Inkress makes one from the email: the part before @ and a random suffix.
phonestring
With country code.
aboutstring
A short description.
sectorstring
What it does.
business_typestring
Its legal form.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
The merchant, status 32 (unverified). It can take payments once verified (33).
Errors
401 | The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs. |
422 | A required field is missing or the username is taken. |