commerce

GET /v1/refund-requests/{refundRequestId}

Get a refund request.

All commerce endpoints

Authentication

Send an API key as a bearer token. The key must carry the billing.view 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 GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

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

Returns one refund request in scope, with its policy class, amount and outcome. Requires `billing.view`.

Parameters

NameTypeRequiredWhat it is
refundRequestId (path)UuidYesThe refund request's id.

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
org_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
order_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
statusRefundRequestStatusYesA refund request's lifecycle state (docs/05 §4.13).
policy_classRefundPolicyClassYesHow the refund policy classified a request (captured at request time).
amountMoneyAmountYesA money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
to_walletbooleanYesRefund 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…
reasonstringYes
decided_bystringYes
decision_notestringYes
decided_atobjectYes
refund_referencestringYesSet once the refund has been issued (its idempotency key).
created_atstringYes
updated_atstringYes

Errors this endpoint can return

401 · 403 · 404 · 429