public

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

Start paying an invoice on our checkout. Unauthenticated.

Hitelesítés

Ez a végpont nyilvános. Nem igényel hitelesítő adatot és szervezetet sem – ezt olvassa a saját marketingoldalunk és az MI-válaszadó motorunk is.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`token (path)`	`string`	Igen	—

Kérés törzse

Név	Típus	Kötelező	Mi ez
`gateway`	`string`	Nem	The rail to settle on. Omit to follow the platform default.

Válasz

Név	Típus	Kötelező	Mi ez
`status`	`string`	Igen	—
`settled`	`boolean`	Igen	—
`amount_minor`	`integer`	Igen	—
`currency`	`string`	Igen	—
`client_token`	`string`	Nem	A card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else.
`redirect_url`	`string`	Nem	An approval page to send the payer to (PayPal, a crypto invoice).
`action_kind`	`string`	Nem	`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`	Nem	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…

Hibák, amelyeket ez a végpont visszaadhattatlan

404 · 409 · 429 · 503

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