Skip to main content

Visão geral

Este endpoint permite reembolsar uma transação já paga, total ou parcialmente. Reembolsos via Pix são processados quase instantaneamente; reembolsos de cartão podem levar alguns dias úteis para aparecer na fatura do cliente.

Endpoint

curl --request POST \
  --url https://api.avanttifinance.com/v1/transactions/{transaction_id}/refund \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO" \
  --header "Content-Type: application/json" \
  --data '{
    "amount": 15000,
    "reason": "solicitação do cliente"
  }'

Parâmetros de path

transaction_id
string
required
Identificador único da transação a ser reembolsada.

Parâmetros do corpo

amount
integer
Valor a ser reembolsado, em centavos. Se omitido, reembolsa o valor total da transação.
reason
string
Motivo do reembolso, para fins de registro e auditoria.

Resposta

id
string
Identificador único do reembolso.
transaction_id
string
Identificador da transação reembolsada.
amount
integer
Valor reembolsado, em centavos.
status
string
Status do reembolso: pending, completed ou failed.

Exemplo de resposta

{
  "id": "ref_5a6b7c8d9e",
  "transaction_id": "txn_8f3a1b2c9d",
  "amount": 15000,
  "status": "completed",
  "created_at": "2026-06-11T10:00:00Z"
}
Reembolsos não podem ser revertidos. Verifique cuidadosamente o valor e a transação antes de confirmar a operação.

Erros comuns

Código HTTPSignificado
400Valor de reembolso maior que o saldo disponível da transação
401Token de autenticação inválido ou ausente
404Transação não encontrada
409Transação já reembolsada totalmente

Próximos passos

Listar reembolsos

Consulte o histórico de reembolsos da sua conta.

Ver transação

Consulte os detalhes de uma transação específica.