Skip to main content
POST
Solicitar devolução
Solicita a devolução integral de uma cobrança paga.
O id da cobrança é passado como query string, sem body: POST /transparents/refund?id=chg_018f8e2d9a5f7b10c3d4. Não existe devolução parcial — o valor devolvido é sempre o total ainda não devolvido da cobrança.

Pré-requisitos

  • A cobrança precisa estar com status = PAID
  • A cobrança ainda não pode ter sido devolvida integralmente
  • O merchant precisa ter saldo disponível para cobrir o valor
Exemplo:
Resposta:

Como funciona

1

Validamos o saldo

O valor da cobrança é debitado do saldo available do merchant.
2

Criamos o registro de refund

Status inicial: PENDING.
3

Disparamos para o PSP

Solicitação assíncrona ao banco/PSP usando o end2endId da cobrança.
4

Atualizamos o status

COMPLETED quando o PIX de devolução for confirmado, ou FAILED se houver erro — acompanhe pelo webhook REFUND_COMPLETED/REFUND_FAILED.

Erros comuns

A taxa cobrada na cobrança original não é devolvida. Se você cobrou R50,00comtaxadeR 50,00 com taxa de R 0,50 e devolver a cobrança, você terá um prejuízo de R$ 0,50 — debitado do seu saldo.

Authorizations

Authorization
string
header
required

Autentique suas requisições enviando o token no header Authorization: Bearer <token>.

O token pode ser:

Não há distinção de ambiente — toda chave vale para o único ambiente disponível (produção).

Query Parameters

id
string
required
Example:

"chg_018f8e2d9a5f7b10c3d4"

Response

Devolução iniciada.

data
object
required
error
null
required
Example:

null

success
enum<boolean>
required
Available options:
true
Example:

true