Payment confirmation
We assume that the transaction has already been initiated. This is the moment when the payer can confirm the data, such as recipient and value.
From the moment the payer confirms their operation, either on a platform or APP, or even through API, participants must use BS2 API for payment confirmation request, using paymentId
as the main argument generated in the initiation step.
Payment transaction confirmation
To confirm a payment initiated at step Pix Flow, the following fields are required:
Field | Description | Format | Mandatory |
---|---|---|---|
pagamentoId | Payment identifier generated by Banco BS2 | string | Sim |
recebedor | Details of transaction recipient The data entered in this object must be the same as that entered when initiating payment | object | |
retirada | Transaction amount, for Pix Saque and Pix Troco | object | Não |
valor | Transaction amount, for regular Pix (purchase or transfer) | double | Não |
descricaoPagamento | Message to recipient | string | Sim |
tipoPrioridade | Type of transaction priority, as shown in the table Type of Priority | string | Não |
Response:
Field | Description | Format | Mandatory |
---|---|---|---|
pagamentoId | Payment identifier generated by Banco BS2 | string | Sim |
endToEndId | Transaction identifier | Sim | |
situacao | Status of the payment transaction, as shown in the table Payment Status | string | Não |
Collateral account freeze
In the first step after the indirect participant confirms the transaction, Banco BS2 checks whether the participant has sufficient funds in their account for the operation.
The operation will be denied if there is not enough funds in the collateral account, and an error message will display that information. Once there are enough funds in the collateral account, BS2 will immediately freeze the amount in it.
Messages confirming the operation to SPI
After we receive internal confirmation that the funds in the collateral account have been successfully frozen, Banco BS2 will generate a PACS.008 type message, which is a standard message involving the direct participants and the SPI for Pix transfers. It will be sent to the SPI at this time in the case of an immediate operation or, in the case of a scheduled Pix, it will be sent at a later time.
Notification
When Banco BS2 receives the completed transaction confirmation message from the SPI (PACS.002), informing whether the transaction was completed or denied, we will debit the funds form the collateral account in the case of a completed transaction or unfreeze it in the case of a non-performed transaction. Then we will share this information to the participant using the WEBHOOK registered by the participant for this type of operation.
Please go to Webhooks for indirect participants for orientation on how to register notifications.
Updated 8 days ago