commerce

POST `/v1/orders/{orderId}/paypal/capture`

Capture a PayPal order the buyer completed.

身份验证

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

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/paypal/capture \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "paypal_order_id": <string> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Settles the order against a PayPal order the buyer has approved (wallet) or paid by card (including any 3-D Secure step). ⛔ **The browser is not believed.** It reports that the buyer finished; only PayPal's capture response says money moved, and only the engine writes a payment. Posting an invented `paypal_order_id` produces a gateway error, never a paid order. A **declined card answers 200** with the order `payment_failed`, for the same reason `payOrder` does — the attempt was processed exactly as asked.

参数

名称	类型	必填	内容简介
`orderId (path)`	`Uuid`	是	The order's id.

请求正文

名称	类型	必填	内容简介
`paypal_order_id`	`string`	是	The id returned by `openPayPalOrder` and completed in the browser.

响应

名称	类型	必填	内容简介
`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[]`	是	—

此端点可能返回的错误

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/paypal/capture