commerce

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

Pay an order that was placed but not charged.

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`orderId (path)`	`Uuid`	Evet	The order's id.

İstek gövdesi

Ad	Tür	Zorunlu	Ne olduğu
`gateway`	`string`	Hayır	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`.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Evet	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	Evet	Human-friendly order reference.
`status`	`OrderStatus`	Evet	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	Evet	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	Evet	—
`tax_minor`	`integer`	Evet	—
`discount_minor`	`integer`	Evet	—
`total_minor`	`integer`	Evet	—
`billing_country`	`object`	Hayır	—
`placed_at`	`object`	Hayır	—
`created_at`	`string`	Evet	—
`updated_at`	`string`	Hayır	—
`lines`	`OrderLine[]`	Evet	—
`payments`	`Payment[]`	Evet	—
`customer_action`	`object`	Hayır	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…

Bu uç noktanın dönderebileceği hatalar

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay