Reembolsos
Devolver a totalidade ou parte de uma cobrança.
Criar um reembolso
POST /v1/refunds
| Campo | Obrigatório | Descrição |
|---|---|---|
payment_id |
sim | A cobrança original: o seu identificador ou a sua referência |
amount_minor |
— | Cadeia, em unidades menores. Ausente = o saldo restante |
reason |
— | customer_request, duplicate, fraudulent ou other |
description |
— | Texto livre, visível no painel |
O reembolso é uma operação de pleno direito: o seu próprio id, o seu próprio estado, o seu próprio
evento webhook (refund.success / refund.failed).
Regras
- Só uma cobrança bem-sucedida se reembolsa.
- A soma dos reembolsos não pode ultrapassar o montante cobrado — acima disso a API responde
422 invalid_request. - As comissões de cobrança não são devolvidas: ficam a seu cargo.
- Um reembolso parcial deixa a cobrança original consultável, com o seu histórico completo.
- Os fundos são retirados do seu saldo disponível no momento da chamada, como num pagamento.
Uma chave de idempotência por reembolso. Nunca o identificador do pagamento original: uma cobrança pode ser reembolsada em várias vezes, e uma chave com o identificador do pai faria o segundo reembolso parcial passar por um reenvio do primeiro.
Ler e listar
GET /v1/refunds/{id}
GET /v1/refunds