public

POST `/v1/pay/invoices/{token}/checkout`

Start paying an invoice on our checkout. 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/pay/invoices/{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

Joins the platform's ordinary money path at the front. It creates the recipient's lightweight account here and not before — an order is org-scoped and so is the invoice document its payment produces — mints one order for the document (idempotent, so a double tap reaches the same order and the same payment intent), and starts the charge on our own gateway. The response carries whichever credential the chosen rail needs: client_token is a card intent's client secret for the browser SDK, redirect_url is an approval page for PayPal or a crypto invoice. settled: true means the total was zero and the order completed with no gateway at all. ⛔ Nothing here captures money and nothing here decides an order is paid. The gateway's webhook does both, exactly as it does for every other order on the platform.

Parameters

Name	Type	Required	What it is
`token (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`gateway`	`string`	No	The rail to settle on. Omit to follow the platform default.

Response

Name	Type	Required	What it is
`status`	`string`	Yes	—
`settled`	`boolean`	Yes	—
`amount_minor`	`integer`	Yes	—
`currency`	`string`	Yes	—
`client_token`	`string`	No	A card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else.
`redirect_url`	`string`	No	An approval page to send the payer to (PayPal, a crypto invoice).
`action_kind`	`string`	No	`setup` means no card is on file and `client_token` is a SetupIntent secret — confirm it, then call `/confirm`. Anything else is a live charge's own action.
`setup_intent_id`	`string`	No	The SetupIntent the card form is mounted against, echoed back for the `/confirm` call. An id, not a secret: the server re-reads it from the gateway and refuses it unless the…

Errors this endpoint can return

404 · 409 · 429 · 503

POST /v1/pay/invoices/{token}/checkout