Returns - Incoming Flow
The incoming flow for returns is similar to the incoming flow involving Pix transactions, and begins once a PACS.004 message (payment), forwarded by the SPI is sent to Banco BS2.
As a message is intended for indirect participants, Banco BS2 will synchronously request that the participant validate the credit through an API task developed by the indirect participants themselves.
If participants fail to respond to the request within the time limit, we will attempt to resend the notification. (Find out more on Webhooks for indirect participants).
Important:
We will have up to 300 ms to respond to the return validation request.
If the problem persists, Banco BS2 will display the error code AB09 (Transaction interrupted due to an error in the receiving user's participant) to the SPI and the return will not be made.
If the transaction is validated, participants must present return code 200 and, if the transaction was denied, also return code 200, but specifying the reason according to the SPI domain table for return denials.
After going back to step RES2, Banco BS2 will create the PACS.002 (validation) message with the response received from the indirect participant and send it to the SPI.
The SPI will record the transaction in the direct participants' PI account and then notify the direct participants that the transaction has been completed.
When Banco BS2 receives PACS.002 (confirmation), we will credit the amount to the indirect participant's collateral account, and we will notify them through the registered WebHook (Find out more on Notification settings).
From this point on, it will be up to indirect participants to make the credit, notify the end customer and, if applicable, integrate their processes.
Viewing returns
This feature allows you to search for a specific list or return.
List of Returns
In this functionality, you can get a list of returns linked to a Pix transaction.
The following fields are required:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| endToEndId | Identifier of the payment that originated the return | string | Sim |
Resposta:
| Field | Description | Format | Nullable |
|---|---|---|---|
| returnId | Return identifier | string | Sim |
| endToEndId | Identifier of the payment that originated the return | string | Sim |
| valor | Amount to be returned | double | Sim |
| status | Status of return, as shown in the table Status of return | string | Sim |
| solicitadoEmUtc | Date and time the return was requested | date-time | Sim |
| liquidadoEmUtc | Date and time the return was completed | date-time | Sim |
| dataContabil | Accounting date for return | date-time | Sim |
| codigoDevolucao | Reason for refund code that will be sent in PACS004, as shown in the table Reasons for refund | string | Sim |
| tipoDevolucao | Type of refund, as shown in the table Type of refund | string | Sim |
| prioridadeTransacao | Type of transaction priority, as shown in the table Type of Priority | string | Sim |
| motivo | Message to recipient | string | Sim |
| motivoRejeicao | Code and description of the reason the transaction that was informed by BACEN in PACS002 was denied | object | Sim |
| erroDescricao | Description of the return error | string | Sim |
| erroEmUtc | Date and time the error occurred | date-time | Sim |
| webhooks | Information regarding notifications sent to the indirect refund participant | array | Sim |
Viewing returns
This functionality allows you to view a specific return.
The following fields are required:
| Field | Description | Format | Mandatory |
|---|---|---|---|
| endToEndId | Identifier of the payment that originated the return | string | Sim |
| returnId | Return transaction identifier | string | Sim |
Resposta:
| Field | Description | Format | Nullable |
|---|---|---|---|
| returnId | Return identifier | string | Sim |
| endToEndId | Identifier of the payment that originated the return | string | Sim |
| valor | Amount to be returned | double | Sim |
| status | Status of return, as shown in the table Status of return | string | Sim |
| solicitadoEmUtc | Date and time the return was requested | date-time | Sim |
| liquidadoEmUtc | Settlement date for return | date-time | Sim |
| dataContabil | Accounting date for return | date-time | Sim |
| codigoDevolucao | Reason for refund code that will be sent in PACS004, as shown in the table Reasons for refund | string | Sim |
| tipoDevolucao | Type of refund, as shown in the table Type of refund | string | Sim |
| prioridadeTransacao | Priority of transaction, as shown in the table Priority of transaction | string | Sim |
| motivo | Message to recipient | string | Sim |
| motivoRejeicao | Code and description of the reason the transaction that was informed by BACEN in PACS002 was denied | object | Sim |
| erroDescricao | Description of return error | string | Sim |
| erroEmUtc | Date and time of occurrence | date-time | Sim |
| webhooks | Information regarding notifications sent to the indirect refund participant | array | Sim |
Updated 17 days ago