public

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

Start paying an invoice on our checkout. Unauthenticated.

すべての public エンドポイント

すべての開発者向けドキュメント

認証

このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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はい

リクエスト本文

名前タイプ必須これがその内容です
gatewaystringいいえThe rail to settle on. Omit to follow the platform default.

返信

名前タイプ必須これがその内容です
statusstringはい
settledbooleanはい
amount_minorintegerはい
currencystringはい
client_tokenstringいいえA card intent's client secret, for the browser SDK. It authorises confirming this one intent and nothing else.
redirect_urlstringいいえAn approval page to send the payer to (PayPal, a crypto invoice).
action_kindstringいいえ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_idstringいいえ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