Skip to main content
POST
Reembolsar um Checkout
Reembolsa o valor total de um pagamento de checkout, por Pix ou cartão.
Requer a permissão REFUND:CREATE.

Entenda os reembolsos

Regras, status do checkout, upsell, cartão já liquidado, webhooks e todas as mensagens de erro.
O id aceita:
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 público do checkout a reembolsar. Aceita o bill_ do checkout (resolvido para a cobrança paga) ou o ID da cobrança (char_, pix_char_ ou card_).

Example:

"bill_abc123xyz"

reason
string

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

Maximum string length: 500
Example:

"Pedido cancelado pelo cliente."

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