Perform Asynchronous Transfer to Pix QR Code

QR Code Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

METHOD

POST

Request Body

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_type": "qr_code",
  "target_pix_key": "pix@qitech.com.br",
  "pix_message": "Bom dia", 
  "transaction_amount": 500.00,
  "end_to_end_id": "E3240250220211022203051750897529",
  "schedule_date": "2021-08-04",
  "receiver_conciliation_id": "REC00000000000000000000009459463343"
}

Body Param

Field	Type	Description	Max. Characters
request_control_key *	uuidv4	UUID4 for query purposes regarding the request made.	36
pix_transfer_type *	string	Pix has different initiation types, "manual" where the user must send the destination and source account fields and "key" where the user must send the receiver's Pix key fields (destination account) and the source account data.	6
target_pix_key *	string	Pix key that will receive the transaction.	200
pix_message	string	Optional message that will accompany the Pix	140
transaction_amount *	float	Transaction amount	20
end_to_end_id	string	unique identification key for a transaction or query in the Central Bank. Example: E3240250220210615135810450327042	32
schedule_date	date	Transaction scheduling date (if not sent, the transfer is performed upon approval).	10
receiver_conciliation_id *	string	Receiver conciliation identification. Generated when decoding a QR Code	10

HTTP Status 202 Accepted

In asynchronous pix, every transaction returns http status 202 Accepted, the Pix request should not be retried. In this scenario, the transaction will be processed opportunely and will be updated through the Transaction Update Webhook. It is also possible to check the transaction status through the endpoint /account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer/PIX_TRANSFER_KEY.

Response

STATUS

202 Accepted

Response Body

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "pending_confirmation",
  "created_at": "2021-10-22T20:30:23.459Z"
}

STATUS

400

Response Body: Invalid Request Body

{
  "data": {
    "title": "Bad Request",
    "description": "Invalid request body.",
    "translation": "Corpo da requisição inválido.",
    "extra_fields": {},
    "code": "LEG000069"
  }
}

STATUS

202

Response Body: Pending Transfer

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_status": "pending_confirmation",
  "created_at": "2021-10-22T20:30:23.459Z"
}

HTTP Status 202

If http status 202 is returned, the Pix request should not be retried. You need to check the status of the Pix transfer request through a GET on the route /baas/pix/pix_transfer.