commerce

GET `/v1/refund-requests/{refundRequestId}`

Get a refund request.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X GET https://api.zinndigital.com/v1/refund-requests/{refundRequestId} \
  -H "Authorization: Bearer zdk_live_…"

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

Nome	Tipo	Obrigatório	O que é
`refundRequestId (path)`	`Uuid`	Sim	The refund request's id.

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`order_id`	`Uuid`	Sim	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`status`	`RefundRequestStatus`	Sim	A refund request's lifecycle state (docs/05 §4.13).
`policy_class`	`RefundPolicyClass`	Sim	How the refund policy classified a request (captured at request time).
`amount`	`MoneyAmount`	Sim	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`to_wallet`	`boolean`	Sim	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`	Sim	—
`decided_by`	`string`	Sim	—
`decision_note`	`string`	Sim	—
`decided_at`	`object`	Sim	—
`refund_reference`	`string`	Sim	Set once the refund has been issued (its idempotency key).
`created_at`	`string`	Sim	—
`updated_at`	`string`	Sim	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 429

GET /v1/refund-requests/{refundRequestId}