Scenario Simulation

Step-by-step guide to simulate the completion of actions performed by external agents. These simulations include incoming transactions and refunds.

Information

There is no payload response (response body) for these requests.

1 - Simulating an Incoming PIX

Request

ENDPOINT

/mock/pix_transfer/incoming_pix_transfer

METHOD

POST

Request Body

{
  "target_account_key": "fc6862c4-2b20-4057-8063-b8809866e494",
  "target_alias_key": "c4332971-7cff-42eb-a117-7e6f0cd74db2",
  "amount": 100.01
}

Object Request Body

Field	Type	Description	Max. Characters
target_account_key*	string	Unique key of the destination account	36
target_alias_key	string	Unique key of the destination alias	36
amount*	number	Transaction amount	6

2 - Simulation a QR Code Pix payment

Request

ENDPOINT

/mock/pix_transfer/incoming_pix_qrcode

METHOD

POST

Request Body

{
  "target_alias_key": "\<Chave única do alias de destino\>",
  "amount": "\<Valor da transação\>",
  "receiver_conciliation_id": "\<id do receiver conciliation do qr code\>"
}

Object Request Body

Field	Type	Description	Max. Characters	Example	Note
target_alias_key*	string	Unique key of the destination alias	36	"41112f46-0034-4007-85687-5e592173db2"
amount*	decimal	Transaction amount	6	1000.00	Maximum value of 100,000
receiver_conciliation_id*	string	Reconciliation ID of the receiver of the QR code	36	1000

3 - Simulating a PIX Refund

Simulates the refund of an outgoing Pix transfer. The total value of the refunds must not exceed the value of the original transfer. To identify the target transaction, send the end_to_end_id of the original transfer.

Request

ENDPOINT

/mock/pix_transfer/reversal

METHOD

POST

Request Body

{
  "end_to_end_id": "E35713491202309182110sSCNh25ooX2",
  "amount": 100.00
}

Object Request Body

Field	Type	Description	Max. Characters
end_to_end_id*	string	Unit key of the transaction to be refunded	32
amount*	number	Amount to be refunded	6

4 - Simulating a Transaction in Pending Confirmation State

Pix transactions can enter the pending_confirmation status when there is a delay in receiving the Pix transaction response from the Central Bank. To simulate this scenario, make a transaction with the pix key "target_pix_key": "0476f803-0129-430a-a66c-d2f0d7cf4aaa" or, for manual pix transfers, use "owner_document_number": "48094884894" as the document number of the destination account owner. To update the transaction status, make the request below with transaction_status set to sent to approve the transaction, or rejected to reject it.

Request

ENDPOINT

/mock/pix_transfer/pending_confirmation

METHOD

POST

Request Body

{
  "end_to_end_id": "E32402502202308181802vSHbiqNCk9i",
  "transaction_status": "rejected",
  "status_reason_information": {
    "error_description": "description",
    "error_translation": "translation",
    "error_short_description": "short_description"
  },
  "error_code": "test_error"
}

Body Parameters

Field	Type	Description	Max. Characters
end_to_end_id *	string	Unit key of the PIX transaction	36
transaction_status *	enum	Enumerator Transaction Status
status_reason_information	object	Object Status Reason Information
error_code	string	Error code

Enumerator Transaction Status

Enumerator	Description
sent	Completed
rejected	Rejected

Object Status Reason Information

Field	Type	Description	Max. Characters
error_description	string	Description of the error in English	100
error_translation	string	Description of the error in Portuguese	100
error_short_description	string	Short description of the error in English	100

5 - Simulating a Rejected Transaction

Pix transactions can enter the rejected status when there is an expected return of refusal from the Central Bank or the recipient PSP. To simulate this scenario, make a transaction with the pix key "target_pix_key": "b9380607-dac6-4e17-8ca7-eb761e3aa1dc" or, for manual pix transfers, use "owner_document_number": "66972913039" or "owner_document_number": "50305556000164" as the document number of the destination account owner.