commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Cheia trebuie să aibă permisiunea billing.payment.manage; o cheie care nu o are va fi respinsă cu 403, nu 404.
Unde merge ID-ul organizației tale
Acest punct final preia org_id ca câmp în corpul JSON.
ID-ul organizației tale se află pe ecranul cheilor API din panoul de control, lângă cheia însăși. Este același ID în fiecare apel pe care îl faci.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
Opens a refund request per the policy: within the 30-day money-back window the refund is issued immediately (status `auto_approved`); otherwise a pro-rata request is recorded `pending` for staff approval (docs/05 §4.13). The amount and approval path come from the server, never the client. Requires `billing.payment.manage`.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
orderId (path) | Uuid | Da | The order's id. |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
org_id | Uuid | Nu | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Nu | — |
to_wallet | boolean | Nu | Where the refund goes. Omit it and the money is returned to the original payment method — the money-back guarantee is money back, and store credit is an opt-in the customer has… |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Da | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Da | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Da | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Da | Refund destination, frozen at request time — `false` (the default) reverses the original payment, `true` credits the account wallet. Any part of the order that was settled from… |
reason | string | Da | — |
decided_by | string | Da | — |
decision_note | string | Da | — |
decided_at | object | Da | — |
refund_reference | string | Da | Set once the refund has been issued (its idempotency key). |
created_at | string | Da | — |
updated_at | string | Da | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 409 · 422 · 429