Webhook do Cobrança
Notificamos os nossos clientes acerca de todas as ocorrências relacionadas aos boletos gerados pelo BS2.
Quando um boleto for, por exemplo, registrado, pago, liquidado ou tiver quaisquer outras ocorrências, utilizamos o Webhook para enviar tais notificações.
Nota:
Para utilizar o webhook, entre em contato com seu representante comercial informando uma URL para que possamos ativar o webhook para você.
Contrato do Webhook
O webhook será disparado via uma requisição HTTP POST até que o cliente retorne com um status de sucesso (família HTTP 200).
Abaixo, o contrato do webhook utilizado para a notificação:
| Campo | Descrição |
|---|---|
| Id | Código único da notificação |
| DataNotificacao | Data do disparo do webhook ao parceiro |
| NossoNumeroBoleto | Valor do campo nosso número do boleto |
| SeuNumeroBoleto | Valor seu número enviado no momento da criação do boleto |
| Valor | Valor original do boleto |
| ValorLiquidado | Valor que foi pago pelo cliente (se o boleto já tiver sido pago) |
| SituacaoDescricao | Descrição da situação do boleto |
| Situacao | Define a situação do boleto [Vide tabela Códigos de Situação] |
| StatusBoleto | Define o status do boleto [Vide tabela Código de Status] |
Código de status
No objeto StatusBoleto enviamos os seguintes campos:
- Status: código do status do evento, conforme tabela de status abaixo;
- Descrição: descrição do status do boleto;
- DataStatus: data em que o evento ocorreu
Abaixo, a tabela de status que um boleto pode ter:
| Status | Descrição |
|---|---|
| 1 | Boleto Registrado junto ao órgão responsável - CIP |
| 2 | Identificado pagamento do boleto na rede bancária ⚠️ |
| 3 | Boleto liquidado/compensado - crédito feito na CC ⚠️ |
| 4 | Boleto cancelado/baixado (sem movimentação financeira) |
Importante:
- Ressaltamos que o processo em que é efetivamente identificado o pagamento e recebimento do valor junto ao Banco BS2 é o status 3 Boleto liquidado/compensado - crédito feito na CC do objeto StatusBoleto.
- No processo entre o pagamento do boleto na rede bancária (status = 2) e a compensação efetiva do boleto (status =3), podem existir problemas que impedem o recebimento do valor do boleto junto ao Banco BS2. Nesse caso, muitas vezes, o Banco BS2 não tem poder de atuação.
- É importante identificar, dentro da sua operação, qual a maneira ideal e mais segura de se beneficiar de cada um destes eventos informados.
Códigos de Situação
A seguir, confira a relação de situações possíveis enviadas no campo Situacao e suas descrições:
| Situação | Descrição |
|---|---|
| 1 | Boleto em aberto - A vencer |
| 2 | Boleto em aberto - Vencido |
| 3 | Boleto Cancelado / Baixado |
| 4 | Boleto Liquidado / Compensado |
Updated 6 months ago