commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Autentifikimi
Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen billing.payment.manage; një çelës pa të refuzohet me 403, jo 404.
Ku shkon id i organizatës suaj
Ky endpoint pranon org_id si fushë në trupin JSON.
ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.
Provoje
Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së
Detajet
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`.
Parametrat
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
orderId (path) | Uuid | Po | The order's id. |
Trupi i kërkesës
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
org_id | Uuid | Jo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Jo | — |
to_wallet | boolean | Jo | 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… |
Përgjigja
| Emri | Lloji | Kërkohet | Çfarë është kjo |
|---|---|---|---|
id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Po | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Po | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Po | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Po | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Po | 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 | Po | — |
decided_by | string | Po | — |
decision_note | string | Po | — |
decided_at | object | Po | — |
refund_reference | string | Po | Set once the refund has been issued (its idempotency key). |
created_at | string | Po | — |
updated_at | string | Po | — |
Gabimet që ky pikëndalim mund të kthejë
401 · 403 · 404 · 409 · 422 · 429