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:
Campo | Descrição | Formato | Obrigatório |
---|---|---|---|
url | Endereço em que serão recebidas as notificações pelos clientes. | String | Sim |
quantidadeRetentativas | Número de tentativas em que o evento será enviado devido a inconsistências | Interger | Sim |
tipoEvento | O nome do evento enviado | String | Sim |
intervaloEntreRetentativas | Intervalo de tempo em que a retentativa será executada | String | Sim |
usuarioCriacao | Objeto contendo os dados do usuário | Objeto | Sim |
nome | Nome do usuário | String | Sim |
E-mail de cadastro do cliente | String | Sim | |
identificador | Identificador do usuário | String | Sim |
autenticacao | Objeto contendo os dados da autenticação | Objeto | Sim |
valor | Valor da chave de autenticação | String | Sim |
tipo | Tipo de autenticação - Ex: Token | String | Sim |
Exemplo de resposta:
Campo | Descrição | Formato |
---|---|---|
Status Code | Solicitação de criação efetuada | 201 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:
Campo | Descrição | Formato | Obrigatório |
---|---|---|---|
configuracaoId | Identificador da configuração de webhook para atualização | String | Sim |
url | Endereço em que serão recebidas as notificações pelos clientes | String | Sim |
quantidadeRetentativas | Número de tentativas em que o evento será enviado devido inconsistências | String | Sim |
intervaloEntreRetentativas | Intervalo de tempo em que a retentativa será executada | String | Sim |
usuarioAlteracao | Objeto contendo os dados do usuário | Objeto | Sim |
nome | Nome do usuário | String | Sim |
E-mail de cadastro do cliente | String | ||
identificador | Identificador do usuário | String | Sim |
autenticacao | Objeto contendo os dados da autenticação | Objeto | Sim |
valor | Valor da chave de autenticação | String | Sim |
tipo | Tipo de autenticação, que pode ser: None, Basic ou Bearer | String | Sim |
Exemplo de resposta:
Campo | Descrição | Formato |
---|---|---|
Status Code | Solicitação de criação efetuada | 200 Success |
Realiza a atualização de uma configuração de webhook.
Remover configuração de webhook cadastrado
Exemplo de requisição:
Campo | Descrição | Formato | Obrigatório |
---|---|---|---|
configuracaoId | Identificador da configuração de webhook para atualização (Informado no QueryParams) | String | Sim |
usuarioRemocao | Objeto contendo os dados do usuário responsável pela remoção | Objeto | Sim |
nome | Nome do usuário | String | Sim |
E-mail de cadastro do cliente | String | Sim | |
identificador | Identificador do usuário | String | Sim |
Exemplo de resposta:
Campo | Descrição | Formato |
---|---|---|
Status Code | Solicitação de criação efetuada | 204 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.
Campo | Descrição | Formato | Obrigatório |
---|---|---|---|
certificado | Enviar o certificado X.509 codificado em base64 da rota do seu webhook (Arquivo *.cer) | String | Sim |
Exemplo de resposta:
Campo | Descrição | Formato |
---|---|---|
Status Code | Solicitação de criação efetuada | 201 Created |
Realiza a adição de um certificado para a configuração de webhook.
Eventos notificados
Campo | Descrição |
---|---|
BoletoHibridoErroValidacao | Notificação de inconsistência de Chaves Pix (DICT) |
BoletoHibridoEmitido | Notificação do processo de emissão do boleto híbrido |
BoletoHibridoRegistrado | Notificação de finalização de registro do boleto híbrido (Nuclea + Pix) |
BoletoHibridoFalhaCancelamento | Notificação de inconsistência no processo de baixa de um boleto híbrido |
BoletoHibridoCancelado | Notificação de baixa executada com sucesso (solicitações de baixa, liquidações e vencimentos) |
BoletoHibridoLiquidado | Notificação de pagamento de um boleto híbrido |
BoletoHibridoFalhaLiquidacao | Notificação de inconsistência no processo de liquidação |
Updated about 2 months ago