commerce
POST /v1/orders/{orderId}/refund-request
Request a refund for an order.
Autenticazione
Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione billing.payment.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.
L'ID della tua organizzazione va qui
Questo endpoint accetta org_id come campo nel corpo JSON.
L'identificativo della tua organizzazione si trova nella schermata delle chiavi API nella tua dashboard, accanto alla chiave stessa. È lo stesso identificativo in ogni chiamata che effettui.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X POST https://api.zinndigital.com/v1/orders/{orderId}/refund-request \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
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`.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
orderId (path) | Uuid | Sì | The order's id. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
org_id | Uuid | No | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
reason | string | No | — |
to_wallet | boolean | No | 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… |
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Sì | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Sì | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Sì | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Sì | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Sì | 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 | Sì | — |
decided_by | string | Sì | — |
decision_note | string | Sì | — |
decided_at | object | Sì | — |
refund_reference | string | Sì | Set once the refund has been issued (its idempotency key). |
created_at | string | Sì | — |
updated_at | string | Sì | — |
Errori che questo endpoint può restituire
401 · 403 · 404 · 409 · 422 · 429