commerce
POST /v1/orders/{orderId}/paypal/capture
Capture a PayPal order the buyer completed.
Authentication
Send an API key as a bearer token. The endpoint checks billing.payment.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orderId (path) | Uuid | Yes | The order's id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
paypal_order_id | string | Yes | The id returned by openPayPalOrder and completed in the browser. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
human_ref | string | Yes | Human-friendly order reference. |
status | OrderStatus | Yes | An order's lifecycle state (docs/31 §4.3). |
currency | CurrencyCode | Yes | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
subtotal_minor | integer | Yes | — |
tax_minor | integer | Yes | — |
discount_minor | integer | Yes | — |
total_minor | integer | Yes | — |
billing_country | object | No | — |
placed_at | object | No | — |
created_at | string | Yes | — |
updated_at | string | No | — |
lines | OrderLine[] | Yes | — |
payments | Payment[] | Yes | — |
coverage | PaymentCoverage | null | No | What paying this order buys, said BEFORE the customer pays (s1014 R40, docs/747 §2a): the subscription period it covers, the periods still owed after it, and whether the services… |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503