public

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

The payer entered a card — record it and take the money. 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}/confirm \
  -H "Content-Type: application/json" \
  -d '{ "setup_intent_id": <string> }'

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 second half of a two-step that cannot be collapsed into one. A payer with no card on file gets a SetupIntent from /checkout, confirms it in the browser, and lands here; this records the mandate and then charges the order. Charging on the first call instead would put a failed payment on the order — this platform classifies a mandate-less charge as nothing was presented — and the capture webhook refuses to settle one of those, so the money would be taken and never recorded. setup_intent_id is an id and not a credential. The mandate behind it is re-read from the gateway and refused unless the gateway itself says it belongs to this invoice's payer, so holding one pay link cannot attach a stranger's saved card.

Parameters

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

Request body

Name	Type	Required	What it is
`setup_intent_id`	`string`	Yes	—

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

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