commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Kimlik Doğrulama
Bearer token olarak bir API anahtarı gönderin. Anahtar billing.payment.manage iznine sahip olmalıdır; bu izne sahip olmayan bir anahtar 404 ile değil, 403 ile reddedilir.
Kurum kimliğinizin yazılacağı yer
Bu uç nokta, JSON gövdesinde bir alan olarak org_id alır.
Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
orderId (path) | Uuid | Evet | The order's id. |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
org_id | Uuid | Hayır | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Hayır | — |
to_wallet | boolean | Hayır | 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… |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Evet | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Evet | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Evet | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Evet | 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 | Evet | — |
decided_by | string | Evet | — |
decision_note | string | Evet | — |
decided_at | object | Evet | — |
refund_reference | string | Evet | Set once the refund has been issued (its idempotency key). |
created_at | string | Evet | — |
updated_at | string | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 409 · 422 · 429