commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Authentication
Send an API key as a bearer token. The key must carry the billing.refund permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
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.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
refundRequestId (path) | Uuid | Yes | The refund request's id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
note | string | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
order_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
status | RefundRequestStatus | Yes | A refund request's lifecycle state (docs/05 §4.13). |
policy_class | RefundPolicyClass | Yes | How the refund policy classified a request (captured at request time). |
amount | MoneyAmount | Yes | A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8). |
to_wallet | boolean | Yes | 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 | Yes | — |
decided_by | string | Yes | — |
decision_note | string | Yes | — |
decided_at | object | Yes | — |
refund_reference | string | Yes | Set once the refund has been issued (its idempotency key). |
created_at | string | Yes | — |
updated_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 409 · 422 · 429