commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Санҷиши ҳаққоният
Kaliti API-ро ҳамчун рамзи доранда (bearer token) фиристед. Калит бояд дорои иҷозати billing.payment.manage бошад; калиди бидуни он бо хатои 403 рад карда мешавад, на 404.
Ҷое, ки рақами мушаххаси ташкилоти шумо ҷойгир аст
Ин нуқтаи поёнӣ org_id -ро ҳамчун майдон дар бадани JSON мегирад.
Rakami муайянкунандаи ташкилоти шумо дар экрани калидҳои API дар панели идоракунии шумо, дар паҳлӯи худи калид ҷойгир аст. Ин як раками муайянкунанда дар ҳар یک дархосте, ки шумо иҷро мекунед, якхела аст.
Санҷидан
Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Воarid шудаед? Консоли API дар панели идоракунии шумо рақами мушаххаси ташкилоти воқеӣ ва калиди худро пур мекунад ва дархостро бар зидди API-и фаъол иҷро мекунад, то шумо посухи воқеиро бубинед. Ин нуқтаи ниҳоиро дар консоли API кушоед
Тафсилот
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`.
Параметрҳо
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
orderId (path) | Uuid | Бале | The order's id. |
Ҷисми дархост
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
org_id | Uuid | Не | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Не | — |
to_wallet | boolean | Не | 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… |
Ҷавоб
| Ном | Намуд | Талаб карда мешавад | Ин чӣ аст |
|---|---|---|---|
id | Uuid | Бале | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Бале | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Бале | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Бале | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Бале | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Бале | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Бале | 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 | Бале | — |
decided_by | string | Бале | — |
decision_note | string | Бале | — |
decided_at | object | Бале | — |
refund_reference | string | Бале | Set once the refund has been issued (its idempotency key). |
created_at | string | Бале | — |
updated_at | string | Бале | — |
Хатоҳое, ки ин нуқтаи ниҳоӣ метавонад баргардонад
401 · 403 · 404 · 409 · 422 · 429