commerce

GET `/v1/orders/{orderId}/refund-eligibility`

Preview an order's refund eligibility.

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/orders/{orderId}/refund-eligibility \
  -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

The refund policy's decision for this order without opening a request — whether it is eligible, the amount that would be refunded, and whether it needs staff approval (docs/05 §4.13). Requires `billing.view`.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`orderId (path)`	`Uuid`	Sim	The order's id.

Resposta

Nome	Tipo	Obrigatório	O que é
`eligible`	`boolean`	Sim	—
`policy_class`	`RefundPolicyClass`	Sim	How the refund policy classified a request (captured at request time).
`requires_approval`	`boolean`	Sim	—
`auto_approved`	`boolean`	Sim	Eligible and needs no human — the money-back path issues immediately.
`amount`	`MoneyAmount`	Sim	A money value — integer minor units + an ISO 4217 code (CLAUDE.md §2.8).
`reason`	`string`	Sim	A customer-safe explanation of the decision.

Erros que este endpoint pode retornar

401 · 403 · 404 · 429

GET /v1/orders/{orderId}/refund-eligibility