commerce

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

Pay an order that was placed but not charged.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`orderId (path)`	`Uuid`	כן	The order's id.

גוף הבקשה

שם	סוג	נדרש	מה זה
`gateway`	`string`	לא	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`.

תשובה

שם	סוג	נדרש	מה זה
`id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	כן	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`human_ref`	`string`	כן	Human-friendly order reference.
`status`	`OrderStatus`	כן	An order's lifecycle state (docs/31 §4.3).
`currency`	`CurrencyCode`	כן	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`subtotal_minor`	`integer`	כן	—
`tax_minor`	`integer`	כן	—
`discount_minor`	`integer`	כן	—
`total_minor`	`integer`	כן	—
`billing_country`	`object`	לא	—
`placed_at`	`object`	לא	—
`created_at`	`string`	כן	—
`updated_at`	`string`	לא	—
`lines`	`OrderLine[]`	כן	—
`payments`	`Payment[]`	כן	—
`customer_action`	`object`	לא	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…

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay