Webhook do Boleto Híbrido

Notificamos os nossos clientes acerca de todas as ocorrências relacionadas aos boletos híbridos gerados pelo BS2.

Quando um boleto híbrido for, por exemplo, registrado, liquidado, cancelado ou tiver quaisquer outras ocorrências, utilizamos o Webhook para enviar tais notificações.



Cadastro de rota

Adição de uma nova configuração de webhook:

Solicitamos os campos:

CampoDescriçãoFormatoObrigatório
urlEndereço em que serão recebidas as notificações pelos clientes.StringSim
quantidadeRetentativasNúmero de tentativas em que o evento será enviado devido a inconsistênciasIntergerSim
tipoEventoO nome do evento enviadoStringSim
intervaloEntreRetentativasIntervalo de tempo em que a retentativa será executadaStringSim
usuarioCriacaoObjeto contendo os dados do usuárioObjetoSim
nomeNome do usuárioStringSim
emailE-mail de cadastro do clienteStringSim
identificadorIdentificador do usuárioStringSim
autenticacaoObjeto contendo os dados da autenticaçãoObjetoSim
valorValor da chave de autenticaçãoStringSim
tipoTipo de autenticação - Ex: TokenStringSim

Exemplo de resposta:

CampoDescriçãoFormato
Status CodeSolicitação de criação efetuada201 Created

Adiciona uma nova configuração de webhook para notificar o cliente por tipo de evento.

Atualizar configuração de webhook cadastrado

Exemplo de requisição:

CampoDescriçãoFormatoObrigatório
configuracaoIdIdentificador da configuração de webhook para atualizaçãoStringSim
urlEndereço em que serão recebidas as notificações pelos clientesStringSim
quantidadeRetentativasNúmero de tentativas em que o evento será enviado devido inconsistênciasStringSim
intervaloEntreRetentativasIntervalo de tempo em que a retentativa será executadaStringSim
usuarioAlteracaoObjeto contendo os dados do usuárioObjetoSim
nomeNome do usuárioStringSim
emailE-mail de cadastro do clienteString
identificadorIdentificador do usuárioStringSim
autenticacaoObjeto contendo os dados da autenticaçãoObjetoSim
valorValor da chave de autenticaçãoStringSim
tipoTipo de autenticação, que pode ser: None, Basic ou BearerStringSim

Exemplo de resposta:

CampoDescriçãoFormato
Status CodeSolicitação de criação efetuada200 Success

Realiza a atualização de uma configuração de webhook.

Remover configuração de webhook cadastrado

Exemplo de requisição:

CampoDescriçãoFormatoObrigatório
configuracaoIdIdentificador da configuração de webhook para atualização (Informado no QueryParams)StringSim
usuarioRemocaoObjeto contendo os dados do usuário responsável pela remoçãoObjetoSim
nomeNome do usuárioStringSim
emailE-mail de cadastro do clienteStringSim
identificadorIdentificador do usuárioStringSim

Exemplo de resposta:

CampoDescriçãoFormato
Status CodeSolicitação de criação efetuada204 No Content

Realiza a remoção de uma configuração de webhook.

Criar certificado de configuração de webhook

Após cadastrar o webhook, é preciso registrar o certificado do DNS da rota parametrizada, na funcionalidade.

CampoDescriçãoFormatoObrigatório
certificadoEnviar o certificado X.509 codificado em base64 da rota do seu webhook (Arquivo *.cer)StringSim

Exemplo de resposta:

CampoDescriçãoFormato
Status CodeSolicitação de criação efetuada201 Created

Realiza a adição de um certificado para a configuração de webhook.

Eventos notificados


CampoDescrição
BoletoHibridoErroValidacaoNotificação de inconsistência de Chaves Pix (DICT)
BoletoHibridoEmitidoNotificação do processo de emissão do boleto híbrido
BoletoHibridoRegistradoNotificação de finalização de registro do boleto híbrido (Nuclea + Pix)
BoletoHibridoFalhaCancelamentoNotificação de inconsistência no processo de baixa de um boleto híbrido
BoletoHibridoCanceladoNotificação de baixa executada com sucesso (solicitações de baixa, liquidações e vencimentos)
BoletoHibridoLiquidadoNotificação de pagamento de um boleto híbrido
BoletoHibridoFalhaLiquidacaoNotificação de inconsistência no processo de liquidação