commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) billing.payment.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a org_id mezőt várja a JSON törzsben.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
orderId (path) | Uuid | Igen | The order's id. |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id | Uuid | Nem | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | Nem | — |
to_wallet | boolean | Nem | 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… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Igen | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Igen | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Igen | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Igen | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Igen | 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 | Igen | — |
decided_by | string | Igen | — |
decision_note | string | Igen | — |
decided_at | object | Igen | — |
refund_reference | string | Igen | Set once the refund has been issued (its idempotency key). |
created_at | string | Igen | — |
updated_at | string | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 409 · 422 · 429