agency-invoicing
POST /v1/agency-invoicing/portal/{token}/checkout
Start a payment on the AGENCY's own gateway. Unauthenticated.
Authentication
This endpoint is public. It takes no credential and no organisation — it is what our own marketing site and AI answer engines read.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
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/agency-invoicing/portal/{token}/checkout \
-H "Content-Type: application/json" \
-d '{ }'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 money settles into the agency's merchant account and never touches Zinn®'s balance. An agency with no connected gateway gets a 409 — there is no fallback, because there is no relationship under which we could take money for a document our name is nowhere near. Returns a client_token for a browser SDK, a redirect_url for an approval or hosted-invoice rail, or a completed capture.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
token (path) | string | Yes | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
provider | string | No | Which of the agency's connected gateways to use. Their default when omitted. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
status | string | Yes | captured when the rail settled synchronously, pending for a crypto invoice or an unconfirmed intent, requires_action for 3-D Secure. |
provider_code | string | No | — |
client_token | string | No | A short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere. |
redirect_url | string | No | Where to send the payer for rails that use an approval or hosted page. |
action_kind | string<authenticate, approve, pay, add_payment_method> | No | — |
amount_minor | integer | Yes | — |
currency | string | Yes | — |
Errors this endpoint can return
404 · 409 · 429 · 503