commerce

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

Pay an order that was placed but not charged.

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

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.

Paramètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`orderId (path)`	`Uuid`	Oui	The order's id.

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`gateway`	`string`	Non	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éponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay