Inkress DevelopersMerchants · Set up a business
API reference / Merchants
Set up a business
POST/api/v1/merchants/partner-activationno app scope
For partner platforms: set up or link one of your businesses and turn on payments, keyed by your own reference. Safe to repeat; call again until state is active. Run merchants.
Body
referencestringrequired
Your ID for the business.
merchantobjectrequired
The business.
namestringrequired
Business name.
emailstringrequired
Business email.
ownerobjectrequired
The person who runs it.
emailstringrequired
Their email.
first_namestringrequired
Their first name.
webhook_urlstring
HTTPS URL for its paid-order notifications.
codestring
The code Inkress emailed the owner, when moving an account that signed up on its own.
Headers
Authorizationheaderrequired
Bearer with your secret key, or the merchant's OAuth token.
Returns
state (active, setting_up, confirmation_sent), link (created, linked, moved), the merchant, the vouch and, once active, its keys.
Errors
403 | This credential can't set up merchants for a partner. |
409 | The account is linked to another business, managed by another platform, shares its email with another account, or the name is taken. |
422 | A required field is missing, webhook_url isn't HTTPS, the code is wrong, or Inkress couldn't create the account. |
429 | Too many wrong codes, or too many codes sent. |
502 | Verification is unavailable. Try again shortly. |
503 | Inkress couldn't send or check the code. Try again shortly. |