Asynchronous Manual Pix Transaction

Request Manual

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/pix_transfer

METHOD

POST

Request Body

{
    "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
    "pix_transfer_type": "manual",
    "target_account": {
      "account_branch": "0001",
      "account_digit": "1",
      "account_number": "2983779",
      "account_type": "checking_account",
      "ispb": "99999004",
      "owner_document_number": "36188081866",
      "owner_name": "USER PF LIMIT LEDGER",
      "owner_person_type": "natural"
    },
    "pix_message": "Bom dia", 
    "transaction_amount": 500.00,
    "schedule_date": "2021-08-04"
}

Body Param

Field	Type	Description	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
target_account *	Object	Destination account - Should only be sent for "manual" type transactions.	Object target_account
pix_message	string	Optional message that will accompany the Pix	140
transaction_amount *	float	Value of the transaction	20
schedule_date	date	Transaction scheduling date (If not sent, the transaction is performed at the time of approval).	10

Object target_account

Field	Type	Description	Characters
account_branch *	string	Branch.	4
account_digit *	string	Account check digit.	1
account_number *	string	Account number.	8
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	14
owner_name *	string	Account holder's name.	120
account_type *	string	Account type, can be checking_account, deposit_account, guaranteed_account, investment_account, saving_account	20
owner_trading_name	string	Trade name for legal entities. Used only for CNPJ	10
ispb *	string	Eight-digit code that identifies banks in the Central Bank's reserve transfer system.	8

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: Manual 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"
}

STATUS

400

Response Body

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