commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Autentikasi
Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin billing.payment.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.
Tempat ID organisasi Anda dimasukkan
Titik akhir ini memerlukan org_id sebagai field dalam bodi JSON.
ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.
Coba
Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API
Detail
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`.
Parameter
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
orderId (path) | Uuid | Ya | The order's id. |
Isi permintaan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
org_id | Uuid | Tidak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Tidak | — |
to_wallet | boolean | Tidak | 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… |
Tanggapan
| Nama | Jenis | Wajib | Tentang apa ini |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Ya | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Ya | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Ya | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Ya | 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 | Ya | — |
decided_by | string | Ya | — |
decision_note | string | Ya | — |
decided_at | object | Ya | — |
refund_reference | string | Ya | Set once the refund has been issued (its idempotency key). |
created_at | string | Ya | — |
updated_at | string | Ya | — |
Kesalahan yang dapat dikembalikan oleh titik akhir ini
401 · 403 · 404 · 409 · 422 · 429