commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
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/refund-requests/{refundRequestId}/approve \
-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
Approves a pending (pro-rata / goodwill) refund request and issues the refund. Staff-only — requires the `billing.refund` permission held by a staff role, not by any customer role.
Parametri
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
refundRequestId (path) | Uuid | Sì | The refund request's id. |
Corpo della richiesta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
note | string | No | — |
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