public

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

Start paying an invoice on our checkout. Unauthenticated.

Autentizace

Tento koncový bod je veřejný. Nevyžaduje žádná pověření ani organizaci – je to to, co čte náš vlastní marketingový web a naše AI vyhledávače.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/pay/invoices/{token}/checkout \
  -H "Content-Type: application/json" \
  -d '{  }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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.

Parametry

Název	Typ	Požadováno	Co to je
`token (path)`	`string`	Ano	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`gateway`	`string`	Ne	The rail to settle on. Omit to follow the platform default.

Odpověď

Název	Typ	Požadováno	Co to je
`status`	`string`	Ano	—
`settled`	`boolean`	Ano	—
`amount_minor`	`integer`	Ano	—
`currency`	`string`	Ano	—
`client_token`	`string`	Ne	A card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else.
`redirect_url`	`string`	Ne	An approval page to send the payer to (PayPal, a crypto invoice).
`action_kind`	`string`	Ne	`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`	Ne	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…

Chyby, které může tento koncový bod vrátit

404 · 409 · 429 · 503

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