commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
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
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
refundRequestId (path) | Uuid | Da | The refund request's id. |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
note | string | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Da | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Da | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Da | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Da | 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 | Da | — |
decided_by | string | Da | — |
decision_note | string | Da | — |
decided_at | object | Da | — |
refund_reference | string | Da | Set once the refund has been issued (its idempotency key). |
created_at | string | Da | — |
updated_at | string | Da | — |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 409 · 422 · 429