commerce

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

Pay an order that was placed but not charged.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`orderId (path)`	`Uuid`	Sim	The order's id.

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`gateway`	`string`	Não	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`.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	Sim	Human-friendly order reference.
`status`	`OrderStatus`	Sim	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	Sim	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Sim	—
`tax_minor`	`integer`	Sim	—
`discount_minor`	`integer`	Sim	—
`total_minor`	`integer`	Sim	—
`billing_country`	`object`	Não	—
`placed_at`	`object`	Não	—
`created_at`	`string`	Sim	—
`updated_at`	`string`	Não	—
`lines`	`OrderLine[]`	Sim	—
`payments`	`Payment[]`	Sim	—
`customer_action`	`object`	Não	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…

Erros que este endpoint pode retornar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay