Cadastro de rotas

Para que o participante indireto receba as notificações conforme o contrato implementado, será necessário cadastrar suas rotas.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
url	URL que receberá as notificações	string: rota HTTP que receba o verbo POST	Sim
evento	Evento que será recebido na rota, conforme tabela Eventos notificados	string	Sim
autenticacao	Forma de autenticação usada pelo Banco BS2 na rota cadastrada, que podem ser: `Basic`, `Bearer` ou `None`	object	Sim

Resposta:

Campo	Descrição	Formato	Nullable
id	Identificador da configuração da notificação	string	Não
url	URL que receberá as notificações	string	Não
evento	Evento que será recebido na rota, conforme tabela Eventos notificados	string	Não
autenticacao	Forma de autenticação usada pelo Banco BS2 na rota cadastrada, que podem ser: `Basic`, `Bearer` ou `None`	object	Não

Permite cadastrar configurações de rotas para recebimento de webhooks de pagamento, recebimento, devolução e restituição.

Lista de rotas

Ao chamar esta funcionalidade, retornaremos a listagem de todas as configurações de rotas para o recebimento de notificações pelo participante indireto.

Como resposta, o participante indireto obterá uma lista com o seguinte objeto:

Campo	Descrição	Formato	Nullable
id	Identificador da configuração da notificação	string	Não
url	URL que receberá as notificações	string	Não
evento	Evento que será recebido na rota, conforme tabela Eventos notificados	string	Não
autenticacao	Forma de autenticação usada pelo Banco BS2 na rota cadastrada, que podem ser: `Basic`, `Bearer` ou `None`	object	Não

Permite listar as configurações de rotas para recebimento de webhooks.

Alteração de rotas

Nesta funcionalidade, o participante indireto poderá alterar as configurações de uma rota cadastrada.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
configuracaoId	Identificador da configuração da rota	string	Sim
url	URL que receberá as notificações	string	Sim
autenticacao	Forma de autenticação usada pelo Banco BS2 na rota cadastrada, que podem ser: `Basic`, `Bearer` ou `None`	object	Sim

Resposta:

Campo	Descrição	Formato	Nullable
id	Identificador da configuração da notificação	string	Não
url	URL que receberá as notificações	string	Não
evento	Evento que será recebido na rota, conforme tabela Eventos notificados	string	Não
autenticacao	Forma de autenticação usada pelo Banco BS2 na rota cadastrada, que podem ser: `Basic`, `Bearer` ou `None`	object	Não

Permite alterar uma configuração de rota para recebimento de webhooks.

Exclusão de rotas

Nesta funcionalidade, o Participante poderá excluir as configurações de uma rota cadastrada.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
configuracaoId	Identificador da configuração da rota	string	Sim

Devolveremos a resposta HTTP 204 para confirmar a exclusão da rota.

Permite excluir uma configuração de webhook.

Incluindo um certificado X.509

Nesta funcionalidade, o participante indireto deverá informar o certificado que será utilizado para a autenticação no gateway.

Solicitamos os campos:

Campo	Descrição	Formato	Obrigatório
certificado	Enviar o certificado X.509 codificado da rota do seu webhook (Arquivo *.crt)	string	Sim

Devolveremos a resposta HTTP 204 para confirmar a inclusão do certificado.

Permite incluir um certificado X.509

Eventos notificados

A seguir a descrição dos eventos notificados ao participante indireto:

Evento	Descrição
RecebimentoFinalizado	Esta notificação ocorrerá quando o fluxo de recebimento for finalizado com sucesso ou não.
DevolucaoFinalizada	Esta notificação ocorrerá quando o fluxo de devolução for finalizado com sucesso ou não.
PagamentoFinalizado	Esta notificação ocorrerá quando o fluxo de pagamento for finalizado com sucesso ou não.
RestituicaoFinalizada	Esta notificação ocorrerá quando o fluxo de restituição for finalizado com sucesso ou não.
ValidacaoRecebimento	Esta notificação ocorrerá quando um recebimento for enviado ao participante indireto por meio do canal primário de tráfego de mensagens do Banco Central.
ValidacaoRestituicao	Esta notificação ocorrerá quando uma restituição for enviada ao participante indireto.
ValidacaoRecebimentoCanalSecundario	Esta notificação ocorrerá quando um recebimento for enviado ao participante indireto por meio do canal secundário de tráfego de mensagens do Banco Central.