Scenario Simulation
Step-by-step guide to simulate the completion of actions performed by external agents. These simulations include the receipt and updates of infraction reports.
There is no payload response (response body) for these requests, only a response status of 204. The content generated by the mock should be received via webhook.
1 - Simulating the Receipt of an Infraction Report
Simulates the receipt of an infraction report opened by another institution.
It is essential to have a valid pix_transfer_key to send the request, regardless of the information from the other party of the transfer, as all information from the second participant will be replaced in the mock process.
Request
Request Body
{
"infraction_report_status": "acknowledged",
"pix_transfer_key": "28290ff2-2ba7-4e85-9a5e-862c92259b33",
"infraction_report_type": "refund_request",
"infraction_report_situation": "scam",
"infraction_report_details": "Transação com suspeita de fraude.",
}
Object Request Body
| Field | Type | Description | Max. Characters |
|---|---|---|---|
| infraction_report_status* | string | Status of receipt of the infraction report. "acknowledged". | Enumerators infraction_report_status |
| pix_transfer_key* | string | UUID4, unique key identifying the related transaction. | 36 |
| infraction_report_type* | string | Type of Infraction Report | Enumerators infraction_report_type |
| infraction_report_situation* | string | Situation in which the infraction occurred | Enumerators infraction_report_situation |
| infraction_report_details* | string | Details of the infraction report | 2000 |
Enumerators infraction_report_status
| Field | Type | Description | Characters |
|---|---|---|---|
open | string | Infraction report was created and is open at BACEN. | - |
acknowledged | string | Infraction report was received by the participant | - |
cancelled | string | Infraction report is cancelled at BACEN | - |
closed | string | Infraction report is closed at BACEN | - |
Enumerators infraction_report_type
| Field | Type | Description | Characters |
|---|---|---|---|
refund_request | string | Infraction report will be generated to request a refund. | - |
refund_cancelled | string | Infraction report will be generated due to a cancelled refund. | - |
Enumerators infraction_report_situation
| Field | Type | Description | Characters |
|---|---|---|---|
scam | string | Cause of scam or fraud. | - |
account_takeover | string | Cause of unauthorized transaction from the origin account. | - |
coercion | string | Cause of coercion crime. | - |
fraudulent_access | string | Cause of fraudulent access to the origin account. | - |
other | string | Any causes not applicable to those listed above. | - |
2 - Simulating the Update of an Infraction Report
Simulates the status update of an infraction report opened by the indirect participant. The simulation options for updating an infraction report are: 1 - Cancellation: Simulates the cancellation (cancel), made by the other participant, of an infraction report previously opened by themselves.
2 - Closure: Simulates the closure (close), made by the other participant, of an infraction report opened by the indirect participant.
Request
Request Body - Cancel
The Infraction Report identified by the infraction_report_key must have been previously created in the simulation of receiving an infraction report.
{
"infraction_report_status": "cancelled",
"infraction_report_key": "28290ff2-2ba7-4e85-9a5e-862c92259b34"
}
Request Body - Closing
The Infraction Report identified by the infraction_report_key must have been previously created by the indirect participant and acknowledged in the simulation of updating an infraction report.
{
"infraction_report_status": "closed",
"infraction_report_key": "28290ff2-2ba7-4e85-9a5e-862c92259b34",
"analysis_result": "agreed",
"analysis_details": "Valor bloqueado. Para mais informações ligue para (99) 99999-9999."
}
Object Request Body
| Field | Type | Description | Max. Characters | Information |
|---|---|---|---|---|
| infraction_report_status* | string | New status of the infraction report. "cancelled", "closed" | Enumerators infraction_report_status | ---- |
| infraction_report_key* | string | Unique key of the infraction report | 36 | ---- |
| analysis_result* | string | Result of the infraction report analysis. "agreed" or "disagreed" | Enumerators analysis_result | Mandatory for status "closed" |
| analysis_details* | string | Details of the infraction report analysis. | 2000 | Mandatory for status "closed" |
Enumerators analysis_result
| Field | Type | Description | Characters |
|---|---|---|---|
agreed | string | The Indirect Participant agrees with the Infraction Report created by the other Participant. | - |
disagreed | string | The Indirect Participant disagrees with the Infraction Report created by the other Participant. | - |