Solicitar estorno de pagamento recebido (Refund-In)
Solicita a devolução de um pagamento PIX recebido. O estorno pode ser parcial ou total, desde que dentro do prazo de 89 dias.
Requer token Bearer no header Authorization.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|
id | string | Sim | ID da transação original a ser estornada |
| Campo | Tipo | Obrigatório | Descrição |
|---|
refundValue | number | Sim | Valor a ser estornado em reais (pode ser parcial). Mínimo: 0.01 |
reason | string | Não | Motivo do estorno |
externalId | string | Não | ID externo para identificação da devolução. Na API BACEN, corresponde ao parâmetro id da URL |
{
"refundValue": 50.00,
"reason": "Cliente solicitou devolução",
"externalId": "D123456789"
}
| Campo | Tipo | Descrição |
|---|
transactionId | string | ID da transação de estorno gerada |
externalId | string | ID externo da transação de estorno |
status | string | Status atual da transação de estorno (PENDING, CONFIRMED, ERROR) |
refundValue | number | Valor do estorno em reais |
providerTransactionId | string | ID da transação no provedor (usado para correlação com webhooks) |
generateTime | string | Data/hora de geração da transação de estorno (ISO 8601) |
{
"transactionId": "789",
"externalId": "D123456789",
"status": "PENDING",
"refundValue": 50.00,
"providerTransactionId": "7ef4fc3f-a187-495e-857c-e84d70612761",
"generateTime": "2024-01-15T10:30:00.000Z"
}
| Status | Descrição |
|---|
| 400 | Dados inválidos, transação não encontrada, prazo excedido, ou valor inválido |
| 401 | Token não fornecido ou inválido |
| 404 | Transação pai não encontrada |
| 500 | Erro ao processar solicitação de estorno |
