commerce

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

Capture a PayPal order the buyer completed.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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> }'

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`orderId (path)`	`Uuid`	Igen	The order's id.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`paypal_order_id`	`string`	Igen	The id returned by `openPayPalOrder` and completed in the browser.

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	Igen	Human-friendly order reference.
`status`	`OrderStatus`	Igen	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	Igen	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Igen	—
`tax_minor`	`integer`	Igen	—
`discount_minor`	`integer`	Igen	—
`total_minor`	`integer`	Igen	—
`billing_country`	`object`	Nem	—
`placed_at`	`object`	Nem	—
`created_at`	`string`	Igen	—
`updated_at`	`string`	Nem	—
`lines`	`OrderLine[]`	Igen	—
`payments`	`Payment[]`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429 · 503

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