Inkress DevelopersPlatforms · Run merchants
Run merchants
If businesses sell through your platform, set up their Inkress accounts from yours with one call, keyed by your own reference for each business.
1Set up or link a business
Call POST /api/v1/merchants/partner-activation with your organisation key: your reference for the business, merchant (name, email), owner (email, first_name) and, if you want paid-order notifications, an HTTPS webhook_url.
| If the business… | Inkress… |
|---|---|
| has no Inkress account | creates it in your organisation (link: created). |
| already has one in your organisation | links it (link: linked). |
| signed up to Inkress on its own | emails the owner a code. Call again with the code and the account moves to you (link: moved). |
| is managed by another platform | refuses with 409. |
2Call again until it's active
The call is safe to repeat. state is setting_up while Inkress prepares the account and active once it can take payments; the result then includes its keys (public_key, secret_key); store them as secrets. confirmation_sent means a code went to the owner.
Verification and sign-in links
POST /api/v1/merchants/partner-activation/verify-link gives a single-use link to Inkress's verification page for the business. POST /api/v1/merchants/partner-activation/dashboard-link signs its owner into the Inkress dashboard, for example on payouts; the link lasts 60 seconds.