commerce

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

Pay an order that was placed but not charged.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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 again…

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 422 · 429 · 503

POST /v1/orders/{orderId}/pay