Simulação de Eventos de Webhook de Boleto (Homologação)

Endpoint para simulação de eventos e transições de ciclo de vida de boletos em ambiente de testes. Permite validar a esteira de atualização e o disparo de webhooks sem a necessidade de compensação bancária real.

Corpo da Requisição

Campo	Tipo	Obrigatoriedade	Descrição e Regras
`event`	`string`	Obrigatório	Evento de ciclo de vida a ser simulado: `processing`, `registered`, `failed`, `paid`, `payment_error`, `cancellation_requested`, `cancelled`.
`simulation_data`	`object`	Opcional	Dados complementares do evento. Caso omitido, o sistema utiliza as informações originais do título cadastrado.

Detalhamento do Bloco `simulation_data`

Campo	Tipo	Obrigatoriedade	Descrição e Efeito no Evento
`paid_amount`	`numeric`	Opcional	Valor liquidado/pago (mínimo `0`). Caso omitido no evento `paid`, assume o valor nominal emitido do boleto.
`paid_at`	`string` (data/hora)	Opcional	Data/hora em que ocorreu o pagamento (`YYYY-MM-DD` ou `YYYY-MM-DD HH:mm:ss`). Padrão: data/hora atual da simulação.
`credit_date`	`string` (data)	Opcional	Data prevista de efetivação do crédito na conta (`YYYY-MM-DD`).
`external_reference`	`string`	Opcional	Código identificador transacional da liquidação (máx. 120 caracteres).
`payment_slip_number`	`string`	Opcional	Número do título no registro (máx. 100 caracteres).
`bar_code`	`string`	Opcional	Código de barras do boleto (máx. 255 caracteres).
`bar_code_number`	`string`	Opcional	Linha digitável do boleto (máx. 255 caracteres).
`status`	`string`	Opcional	Mensagem de status complementar ou código de recusa em eventos de falha (máx. 60 caracteres).

Eventos Suportados `event`

Evento	Estado Resultante	Descrição
`processing`	Em Processamento	O boleto entrou na fila de registro.
`registered`	Registrado	O título foi validado e registrado na câmara centralizadora bancária.
`paid`	Liquidado / Pago	O título foi pago. Dispara conciliação financeira e crédito do saldo em conta.
`failed`	Falha de Registro	O título foi rejeitado no registro (ex: inconsistência de dados cadastrais).
`payment_error`	Erro de Pagamento	Aponta divergência ou falha no repasse de liquidação financeira.
`cancellation_requested`	Cancelamento Solicitado	Registra o pedido de baixa ou descarte do boleto na centralizadora.
`cancelled`	Cancelado / Baixado	Conclusão definitiva da baixa do título, invalidando pagamentos futuros.

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

application/json

Bodyapplication/json

Exemplo

{
  "event": "paid",
  "simulation_data": {
    "paid_amount": 150.75,
    "paid_at": "2026-09-28 10:30:00",
    "credit_date": "2026-09-28",
    "external_reference": "SIM-PAY-987654"
  }
}

slip-webhook-simulation

Simulação de Eventos de Webhook de Boleto (Homologação)

Corpo da Requisição

Detalhamento do Bloco `simulation_data`

Eventos Suportados `event`

Requisição

Respostas

slip-webhook-simulation

Simulação de Eventos de Webhook de Boleto (Homologação)#

Corpo da Requisição#

Detalhamento do Bloco simulation_data#

Eventos Suportados event#

Requisição

Respostas

Simulação de Eventos de Webhook de Boleto (Homologação)

Corpo da Requisição

Detalhamento do Bloco `simulation_data`

Eventos Suportados `event`