Route registration

Indirect participants who wish to receive notifications in accordance with the implemented contract, will need to register their routes.

The following fields are required:

Field	Description	Format	Mandatory
url	URL that will receive notifications	String: HTTP route that will accept POST	Yes
evento	Event that will be accepted in the route, as shown in the table Notified events	string	Yes
autenticacao	Form of authentication used by Banco BS2 on the registered route, which can be: `Basic`, `Bearer` or `None`	object	Yes

Response:

Field	Description	Format	Nullable
id	Notification configuration identifier	string	No
url	URL that will receive notifications	string	No
evento	Event that will be accepted in the route, as per the table Notified events	string	No
autenticacao	Form of authentication used by Banco BS2 on the registered route, which can be: `Basic`, `Bearer` or `None`	object	No

List of routes

When using this functionality, we will return a list of all route configurations for receiving notifications to the indirect participant.

In response, indirect participants will obtain a list with the following object:

Field	Description	Format	Mandatory
id	Notification configuration identifier	string	No
url	URL that will receive notifications	string	No
evento	Event that will be accepted in the route, as shown in the table Notified events	string	No
autenticacao	Form of authentication used by Banco BS2 on the registered route, which can`Basic`, `Bearer` or `None`	object	No

This functionality allows indirect participants to change the settings of a registered route.

The following fields are required:

Field	Description	Format	Mandatory
configuracaoId	Route configuration identifier	string	Yes
url	URL that will receive notifications	string	Yes
autenticacao	Form of authentication used by Banco BS2 on the registered route, which can`Basic`, `Bearer` or `None`	object	Yes

Resposta:

Field	Description	Format	Nullable
id	Notification configuration identifier	string	No
url	URL that will receive notifications	string	No
evento	Event that will be accepted in the route, as shown in the table Notified events	string	No
autenticacao	Form of authentication used by Banco BS2 on the registered route, which can`Basic`, `Bearer` or `None`	object	No

This functionality allows participants to delete the settings of a registered route.

The following fields are required:

Field	Description	Format	Mandatory
configuracaoId	Route configuration identifier	string	Yes

We will return HTTP 204 response to confirm route deletion.

This functionality allows indirect participants to inform the certificate that will be used for authentication at the gateway.

The following fields are required:

Field	Description	Format	Mandatory
certificado	Send the encoded X.509 certificate of your webhook route (*.crt file)	string	Yes

We will return HTTP 204 response to confirm route inclusion.

Below is a description of the events notified to indirect participants:

Event	Description
RecebimentoFinalizado	Participants will be notified when the receipt flow is completed successfully or not.
DevolucaoFinalizada	Participants will be notified when the refund flow is completed successfully (or not).
PagamentoFinalizado	Participants will be notified when the payment flow is completed successfully or not.
RestituicaoFinalizada	Participants will be notified when the return flow is completed successfully (or not).
ValidacaoRecebimento	A notification will be sent when a receipt is sent to the indirect participant through the Central Bank's primary message traffic channel.
ValidacaoRestituicao	A notification will be sent when a return is sent to the indirect participants.
ValidacaoRecebimentoCanalSecundario	A notification will be sent when a receipt is sent to the indirect participant through the Central Bank's secondary message traffic channel.