commerce
POST /v1/orders/{orderId}/pay
Pay an order that was placed but not charged.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/pay \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Charges an order left pending_payment (or retries one that is payment_failed), wallet credit first and the remainder on the org's default mandate. This is where the guest funnel's next: "payment" step lands: checkout converts the cart when it places the order, so the cart endpoint cannot settle it afterwards and this is the only surface that can. Idempotent without an Idempotency-Key, unlike checkout. The order already exists and is itself the dedup scope, so a double-submit records the same capture rather than taking a second one. A pay attempt against an already-paid order returns that order unchanged rather than an error. A declined card answers 200, not 402: the attempt was processed exactly as asked and the order comes back payment_failed for the caller to read. Only the platform being unable to charge at all — no gateway configured, or one an operator has deliberately disabled — is a 503. Choosing a gateway. Send gateway to settle this order on a specific rail rather than the org's default mandate — the owner's "settle overdue bills with any gateway they like". It must be one of getOrderPaymentOptions's entries, which is why a reseller's client (who has exactly one) cannot be re-routed. Rails that finish in the browser — PayPal approval, a crypto invoice — answer 200 with the order still pending_payment and a customer_action carrying the URL to send the customer to; the order settles when the gateway's webhook confirms it.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
orderId (path) | Uuid | はい | The order's id. |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
gateway | string | いいえ | The rail to settle on (stripe, paypal, nowpayments). Omit to use the org's nominated payment method. 422 if it is not one of this order's getOrderPaymentOptions. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | はい | Human-friendly order reference. |
status | OrderStatus | はい | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | はい | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | はい | — |
tax_minor | integer | はい | — |
discount_minor | integer | はい | — |
total_minor | integer | はい | — |
billing_country | object | いいえ | — |
placed_at | object | いいえ | — |
created_at | string | はい | — |
updated_at | string | いいえ | — |
lines | OrderLine[] | はい | — |
payments | Payment[] | はい | — |
customer_action | object | いいえ | Present only when the attempt needs the customer to finish it in a browser (PayPal approval, a crypto invoice, a 3-D Secure step). Short-lived and never stored — request it again… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503