commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Dieser Endpunkt gibt in der Spezifikation keine spezifische Berechtigung an. Versehen Sie Ihren Schlüssel daher mit den minimal erforderlichen Rechten und prüfen Sie die Antwort, anstatt Annahmen zu treffen.
Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.
Ausprobieren
Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole
Details
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.
Parameter
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
refundRequestId (path) | Uuid | Ja | The refund request's id. |
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
note | string | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Ja | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Ja | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Ja | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Ja | 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 | Ja | — |
decided_by | string | Ja | — |
decision_note | string | Ja | — |
decided_at | object | Ja | — |
refund_reference | string | Ja | Set once the refund has been issued (its idempotency key). |
created_at | string | Ja | — |
updated_at | string | Ja | — |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 409 · 422 · 429