Cadastrando a Assinatura do Webhook

Através desta funcionalidade é possível criar sua assinatura do webhook informando a URL para qual a API do banco realizará as requisições com os dados das movimentações

Esta funcionalidade deverá ser executada com o token de autorização gerado junto ao BS2.

• Para mais detalhes sobre a autenticação, consultar: https://devs.bs2.com/docs/primeirospassos

Solicitamos os campos:

Campo	Descrição
url	URL do endpoint do cliente, que será requisitado pelo webhood do banco BS2
autorizacao.tipo	Enumeração com a identificação do tipo de autorização usado pelo endpoint do cliente (0-none, 1-Basic, 2-Bearer)
autorizacao.valor	Valor do token que deverá ser utilizado pelo webhook do banco BS2 para comunicação com a url informada.

Resposta:

Campo	Descrição
assinaturaId	Id de identificação da assinatura de webhook criada. Este id será utilizado em fluxos à frente descritos.

API: Cadastrando a Assinatura do Webhook

Registrando seu Certificado

Esta funcionalidade permite o registro do Certificado do cliente junto à Assinatura de Webhook criada para garantir o recebimento das comunicações

Esta funcionalidade deverá ser executada com o token de autorização gerado junto ao BS2.

• Para mais detalhes sobre a autenticação, consultar: https://devs.bs2.com/docs/primeirospassos

Solicitamos os campos:

Campo	Descrição
assinaturaId	Id de identificação da assinatura de webhook existente. Este id pode ser consultado através do fluxo de “Consultando sua Assinatura Existente”
certificado	Arquivo de certificado (binário) X.509 codificado em base64 (Arquivo *.cer)

Resposta:

Campo	Descrição
assinaturaId	Id de identificação da assinatura de webhook à qual o certificado foi vinculada. Este id será utilizado em fluxos à frente descritos.

API: Registrando seu Certificado

Consultando sua Assinatura Existente

Através desta funcionalidade é possível consultar as informações de sua Assinatura de Webhook ativa, para manipulação posterior.

Esta funcionalidade deverá ser executada com o token de autorização gerado junto ao BS2.

• Para mais detalhes sobre a autenticação, consultar: https://devs.bs2.com/docs/primeirospassos

Resposta:

Campo	Descrição
id	Id de identificação da assinatura de webhook existente.
url	URL do endpoint do cliente cadastrada na assinatura de webhook
autorizacao.tipo	Enumeração com a identificação do tipo de autorização usado pelo endpoint do cliente (0-none, 1-Basic, 2-Bearer)
autorizacao.valor	Número da conta corrente, do cliente, vinculada à assinatura do webhook

API: Consultando sua Assinatura Existente

Deletando uma Assinatura

Através desta funcionalidade é possível excluir/deletar uma Assinatura de Webhook ativa.Este procedimento deve ser realizado caso o cliente deseja parar de receber as notificações de movimentações na conta ou caso deseje criar uma nova assinatura de webhook com novos dados.

Esta funcionalidade deverá ser executada com o token de autorização gerado junto ao BS2.

• Para mais detalhes sobre a autenticação, consultar: https://devs.bs2.com/docs/primeirospassos

Solicitamos os campos:

Campo	Descrição
assinaturaId	Id de identificação da assinatura de webhook existente. Este id pode ser consultado através do fluxo de “Consultando sua Assinatura Existente”

API: Deletando uma Assinatura

Conteúdo de Resposta do Webhook

O payload abaixo representa a estrutura de dados que será retornada pelo BS2 à URL cadastrada na Assinatura do Webhook.

{
  "DataHoraOperacao": "2025-07-18T13:44:27.9840154-03:00",
  "DataContabil": "2025-07-18T00:00:00",
  "Observacao": null,
  "ContraParte": {
    "Agencia": 0,
    "ContaNumero": "0",
    "CodigoBanco": 0,
    "Documento": "",
    "Nome": "",
    "Ispb": 0
  },
  "ReferenciaAuxiliar": null,
  "Historico": {
    "Descricao": "",
    "DescricaoAbreviada": "",
    "Codigo": 0
  },
  "Id": "",
  "Documento": null,
  "Referencia": "",
  "Valor": 0,
  "Natureza": "",
  "Protocolo": ""
}