commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Xaqiijinta aqoonsiga
U dir furaha API ah calaamad dusha ah (bearer token). Furaha waa inuu wataa ruqadda billing.payment.manage; furaha aan wadan waxaa loo diidayaa 403, ee ma aha 404.
Meesha aqoonsiga ururkaagu galayo
Boggan waxaa uu qaataa org_id oo ah goob ku jirta JSON body.
Aqoonsiga ururkaagu wuxuu ku yaallaa shaashada furayaasha API ee dashboard-kaaga, oo ku xiga furaha laftiisa. Waa isku aqoonsi wicitaan kasta oo aad sameyso.
Isku day
Ku beddel wax kasta oo ku dhex jira qeebaha xaglaha ah qiimayaashaada, sidoo kalena haystaaha furaha ku beddel fure ka dhex muuqda dashboordigaaga.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Ma sign-garaysay? Qalabka API ee ku jira dashboard-kaagu wuxuu buuxiyaa aqoonsigaaga ururka ee dhabta ah iyo furahaaga gaarka ah, wuxuuna ku shaqeysiiyaa codsiga API-ga nool si aad u aragto jawaabta dhabta ah. Kani ka fur barta kontoroolka ee API
Details
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`.
Cabiraha
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
orderId (path) | Uuid | Haa | The order's id. |
Codsiga jidhkiisa
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
org_id | Uuid | Maya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Maya | — |
to_wallet | boolean | Maya | 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… |
Jawaab
| Magaca | Nooc | Loo baahan yahay | Maxay tahay |
|---|---|---|---|
id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Haa | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Haa | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Haa | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Haa | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Haa | 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 | Haa | — |
decided_by | string | Haa | — |
decision_note | string | Haa | — |
decided_at | object | Haa | — |
refund_reference | string | Haa | Set once the refund has been issued (its idempotency key). |
created_at | string | Haa | — |
updated_at | string | Haa | — |
Cilladaha ay bartaani soo celin karto
401 · 403 · 404 · 409 · 422 · 429