public

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

Start paying an invoice on our checkout. Unauthenticated.

Аутентификация

Этот эндпоинт является публичным. Он не требует учетных данных и организации — его читают наш собственный маркетинговый сайт и поисковые системы на базе ИИ.

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

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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…

Ошибки, которые может возвращать этот эндпоинт

404 · 409 · 429 · 503

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