Aprovar reembolso
Aprova um reembolso pendente e o envia para processamento — no gateway, ou para a coleta de dados bancários no caso do boleto.
POST /refunds/:id/approve
Faz parte do recurso Reembolsos — o objeto, os status e o ciclo estão lá.
Aprova um reembolso que ficou aguardando decisão. A requisição não tem corpo: o que ela faz depende
da forma de pagamento do estorno.
refunded ou failed. Boleto vai para awaiting_bank_details — não há estorno a fazer no
gateway, o valor volta por transferência e é preciso saber para qual conta. A coleta acontece fora
desta API.Idempotency-Key para que um retry por timeout não aprove
duas vezes. Veja Convenções.Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID do refund
Response
Refund aprovado e processado
Identificador único do registro.
ID da transação relacionada ao registro.
ID do pagamento relacionado ao registro.
Valor em centavos.
Moeda no padrão ISO 4217 (ex.: BRL).
Situação do reembolso. Valores: pending, approved, processing, refunded, refused, failed, awaiting_bank_details, bank_details_received, invalid_bank_details, ted_processing.
Motivo informado para a operação.
Origem da solicitação: api, admin, customer ou gateway.
Forma de pagamento (ex.: credit_card, pix, boleto).
Comprador da venda estornada (cust_), copiado da transação quando o estorno é criado. Nulo quando a transação não tem cliente.
Nome do comprador quando o estorno foi criado.
E-mail do comprador quando o estorno foi criado.
Documento do comprador (CPF ou CNPJ) quando o estorno foi criado.
Tipo do documento do comprador: cpf ou cnpj.
Vínculo com a venda de origem, copiado da transação quando o estorno é criado. Nulo quando a venda foi criada direto pela API, sem link de checkout.
Motivo da falha do processamento.
Data e hora em que a solicitação foi revisada (ISO 8601).
Data e hora em que o estorno foi concluído (ISO 8601).
Data e hora de criação do registro (ISO 8601).
Data e hora da última atualização do registro (ISO 8601).