agency-invoicing
POST /v1/agency-invoicing/portal/{token}/checkout
Start a payment on the AGENCY's own gateway. Unauthenticated.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/agency-invoicing/portal/{token}/checkout \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
⛔⛔ The money settles into the **agency's** merchant account and never touches Zinn®'s balance. An agency with no connected gateway gets a `409` — there is no fallback, because there is no relationship under which we could take money for a document our name is nowhere near. Returns a `client_token` for a browser SDK, a `redirect_url` for an approval or hosted-invoice rail, or a completed capture.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
token (path) | string | はい | — |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
provider | string | いいえ | Which of the agency's connected gateways to use. Their default when omitted. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
status | string | はい | `captured` when the rail settled synchronously, `pending` for a crypto invoice or an unconfirmed intent, `requires_action` for 3-D Secure. |
provider_code | string | いいえ | — |
client_token | string | いいえ | A short-lived client-side credential for the gateway's browser SDK. ⛔ Never persisted anywhere. |
redirect_url | string | いいえ | Where to send the payer for rails that use an approval or hosted page. |
action_kind | string<authenticate, approve, pay, add_payment_method> | いいえ | — |
amount_minor | integer | はい | — |
currency | string | はい | — |
このエンドポイントが返すエラー
404 · 409 · 429 · 503