commerce
POST /v1/refund-requests/{refundRequestId}/approve
Approve a pending refund request (staff).
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
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 POST https://api.zinndigital.com/v1/refund-requests/{refundRequestId}/approve \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'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
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
refundRequestId (path) | Uuid | Sim | The refund request's id. |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
note | string | Não | — |
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 · 409 · 422 · 429