commerce

POST /v1/orders/{orderId}/pay

Pay an order that was placed but not charged.

Minden commerce végpont

Az összes fejlesztői dokumentáció

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}/pay \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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

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éterek

NévTípusKötelezőMi ez
orderId (path)UuidIgenThe order's id.

Kérés törzse

NévTípusKötelezőMi ez
gatewaystringNemThe 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.

Válasz

NévTípusKötelezőMi ez
idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidIgenUUIDv7 identifier — sortable by creation time (docs/02 §8).
human_refstringIgenHuman-friendly order reference.
statusOrderStatusIgenAn order's lifecycle state (docs/31 §4.3).
currencyCurrencyCodeIgenISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
subtotal_minorintegerIgen
tax_minorintegerIgen
discount_minorintegerIgen
total_minorintegerIgen
billing_countryobjectNem
placed_atobjectNem
created_atstringIgen
updated_atstringNem
linesOrderLine[]Igen
paymentsPayment[]Igen
customer_actionobjectNemPresent 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 again…

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429 · 503