commerce

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

Pay an order that was placed but not charged.

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

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.

Parametri

Nume	Tip	Obligatoriu	Ce este
`orderId (path)`	`Uuid`	Da	The order's id.

Corp cerere

Nume	Tip	Obligatoriu	Ce este
`gateway`	`string`	Nu	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`.

Răspuns

Nume	Tip	Obligatoriu	Ce este
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	Da	Human-friendly order reference.
`status`	`OrderStatus`	Da	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	Da	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Da	—
`tax_minor`	`integer`	Da	—
`discount_minor`	`integer`	Da	—
`total_minor`	`integer`	Da	—
`billing_country`	`object`	Nu	—
`placed_at`	`object`	Nu	—
`created_at`	`string`	Da	—
`updated_at`	`string`	Nu	—
`lines`	`OrderLine[]`	Da	—
`payments`	`Payment[]`	Da	—
`customer_action`	`object`	Nu	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 agai…

Erori pe care le poate returna acest punct final

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay