reseller

POST /v1/reseller/gateways/{code}

Connect or re-key your own payment gateway.

All reseller endpoints

Authentication

Send an API key as a bearer token. The key must carry the reseller.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/reseller/gateways/{code} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "values": <object> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

The credentials are checked against the provider with a real authenticated call before anything is stored, then written to Vault — never to a database row, a log line, an audit entry or an error message. With `validate_only` the check runs and nothing is stored, returning 200 **even when the credentials are rejected**, because that is the answer being asked for. Requires `reseller.manage`.

Parameters

NameTypeRequiredWhat it is
code (path)stringYesThe gateway code — `stripe`, `paypal` or `nowpayments`.
org_id (query)UuidNoWhich of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r…

Request body

NameTypeRequiredWhat it is
valuesobjectYes`{settings_key: value}` for the fields the gateway declares. Written to Vault, never to a database row, a log line, an audit entry or an error message (CLAUDE.md §2.4).
modestring<test, live>No
validate_onlybooleanNoCheck the credentials and return the result without storing.

Response

NameTypeRequiredWhat it is
healthybooleanYes
detailstringYes

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503