public

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

Start paying an invoice on our checkout. Unauthenticated.

Упълномощаване

Този крайpoint е публичен. Той не изисква данни за удостоверяване и организация — това е съдържанието, което нашият собствен маркетинг сайт и AI машини за отговори четат.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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.

Параметри

Име	Тип	Задължително	Какво представлява
`token (path)`	`string`	Да	—

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`gateway`	`string`	Не	The rail to settle on. Omit to follow the platform default.

Отговор

Име	Тип	Задължително	Какво представлява
`status`	`string`	Да	—
`settled`	`boolean`	Да	—
`amount_minor`	`integer`	Да	—
`currency`	`string`	Да	—
`client_token`	`string`	Не	A card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else.
`redirect_url`	`string`	Не	An approval page to send the payer to (PayPal, a crypto invoice).
`action_kind`	`string`	Не	`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`	Не	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…

Грешки, които този крайpoint може да върне

404 · 409 · 429 · 503

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