Skip to main content
POST
Reembolsar pagamento de link
Reembolsa o valor total de um pagamento feito num link de pagamento, por Pix ou cartão. O link continua ativo.
Requer a permissão REFUND:CREATE.

Entenda os reembolsos

Regras, status, cartão já liquidado, webhooks e todas as mensagens de erro.
O id é o do pagamento: a rota recusa o bill_ do link. Cada pagamento do link é reembolsado separado, e o id dele aparece no dashboard, em Sua Loja → Links de pagamento, na lista de transações do link.
reason é opcional, com até 500 caracteres.

Erros desta rota

As demais mensagens, como saldo insuficiente ou cobrança em disputa, estão em Reembolsos.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Body

application/json
id
string
required

ID da cobrança de um pagamento específico do link (pix_char_, card_ ou char_). O bill_ do link é recusado. O ID de cada pagamento aparece no dashboard, no detalhe das transações do link.

Example:

"pix_char_abc123xyz"

reason
string

Motivo do reembolso. Aparece no histórico da transação.

Maximum string length: 500
Example:

"Cobrança duplicada."

Response

Reembolso criado com sucesso.

data
object
error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true