commerce

POST `/v1/orders/{orderId}/pay`

Pay an order that was placed but not charged.

所有 commerce 端点

所有开发者文档 →

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。

此端点不需要组织 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

POST /v1/orders/{orderId}/pay