Asynchronous Transaction via Pix Key

Request Normal

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

METHOD

POST

Request Body

{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "pix_transfer_type": "key",
  "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"
}

Request Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account key.	36
alias_key	uuidv4	Unique alias key.	36

Body Param

Field	Type	Description	Max. Characters
request_control_key *	uuidv4	UUID4 for querying about the made request.	36
pix_transfer_type *	string	Pix has different types of initiation: "manual" where the user must send the destination and origin account fields, and "key" where the user must send the recipient's Pix key (destination account) and origin account details.	6
transfer_time *	string	Transaction synchronicity information, used to define when the transaction will be processed. If "synchronous", the transaction will be executed immediately, but respecting a maximum limit of transactions per minute. If "asynchronous", the transaction will be processed at an appropriate time	200
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	Value of the transaction	20
end_to_end_id	string	Unique identification key of a transaction or query at the Central Bank. Example: E3240250220210615135810450327042	32
schedule_date	date	Transaction scheduling date (If not sent, the transaction is performed at the time of approval).	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 executed opportunely and 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"
  }
}