Skip to content
API referenceAPI v1admin-sdk 1.1.52Search docs⌘K
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. Made from the name if you leave it out.

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 20 (unverified).

Errors

401The key or token is missing, wrong or revoked, is for the other environment, or doesn't have the scope this endpoint needs.
422A required field is missing or the username is taken.