Create Pix requests
POST {{baseInfraUrl}}/{{version}}/pix-request
Send Pix Requests to accounts hosted in other Pix participants. Direction: Outbound.
| Parameters | Value Type | Description |
|---|---|---|
| amount | REQUIRED | A positive integer that represents the amount in cents to be transferred. Example: amount=100 (R$1.00). |
| externalId | REQUIRED | Safe string that must be unique among all your Pix Requests. Example: externalId=my-unique-id-12345678. |
| senderName | REQUIRED | Sender's full name. Example: senderName=Anthony Edward Stark. |
| senderTaxId | REQUIRED | Sender's taxId (CPF/CNPJ). Example: senderTaxId=01.001.001/0001-01. |
| senderBranchCode | REQUIRED | Sender's bank account branch code. Example: senderBranchCode=1234. |
| senderAccountNumber | REQUIRED | Sender's account number. Example: senderAccountNumber=76543. |
| senderAccountType | REQUIRED | Sender's account type. Options: checking, savings, salaryand payment. |
| receiverName | REQUIRED | Array of strings to tag the entity for future queries. All tags will be converted to lowercase. |
| receiverTaxId | REQUIRED | Receiver's taxId (CPF/CNPJ). Example: receiverTaxId=01.001.001/0001-01. |
| receiverBankCode | REQUIRED | Receiver's bank code. Example: receiverBankCode=20018183. |
| receiverAccountNumber | REQUIRED | Receiver's account number. Example: receiverAccountNumber=76543. |
| receiverBranchCode | REQUIRED | Receiver's bank account branch code. Example: receiverBranchCode=1234. |
| receiverAccountType | REQUIRED | Receiver's account type. Options: checking, savings, salaryand payment. |
| endToEndId | REQUIRED | Central Bank's unique transaction id. Example: endToEndId=E00002649202201172211u34srod19le. |
| receiverKeyId | OPTIONAL | Receiver's Pix Key id. Can be a taxId (CPF/CNPJ), a phone number, an email or a alphanumeric sequence (EVP). Example: receiverKeyId=+5511989898989 |
| reconciliationId | OPTIONAL | Reconciliation id linked to this payment. Example: b77f5236-7ab9-4487-9f95-66ee6eaf1781 |
| description | OPTIONAL | Additional information to be delivered to the receiver. |
| initiatorTaxId | OPTIONAL | Payment initiator's taxId (CPF/CNPJ). Example: 20.018.183/0001-80 |
| cashAmount | OPTIONAL | Amount to be withdrawal from the cashier in cents. Example: 1000 (= R$ 10.00) |
| cashierBankCode | OPTIONAL | Cashier's bank code. Example: 20018183 |
| cashierType | OPTIONAL | Cashier's type. Options: merchant, participantand other |
| tags | OPTIONAL | List of strings to tag the entity for future queries. All tags will be converted to lowercase. |
| method | OPTIONAL | Method used to retrieve receiver's account information. Options: manual, dict, initiator, dynamicQrcode, staticQrcodeand payerQrcode |
Request Body
{"requests"=>[{"amount"=>10000, "cashAmount"=>100, "cashierBankCode"=>"20018183", "cashierType"=>"merchant", "description"=>"A Lannister always pays his debts", "endToEndId"=>"E35547753202201201450u34sDGd19l2", "externalId"=>"my_unique_id_2", "receiverAccountNumber"=>"00000", "receiverAccountType"=>"checking", "receiverBankCode"=>"20018183", "receiverBranchCode"=>"0001", "receiverName"=>"Arya Stark", "receiverTaxId"=>"012.345.678-90", "senderAccountNumber"=>"00000", "senderAccountType"=>"checking", "senderBranchCode"=>"0000", "senderName"=>"jamie Lannister", "senderTaxId"=>"594.739.480-42", "tags"=>["lannister", "chargeback"]}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"message":"Pix request successfully created","requests":[{"amount":10000,"cashAmount":100,"cashierBankCode":"20018183","cashierType":"merchant","created":"2022-05-17T18:58:38.092412+00:00","description":"A Lannister always pays his debts","endToEndId":"E35547753202201201450u34sDGd19l3","externalId":"my_unique_id_1","fee":0,"flow":"out","id":"5632510516002816","initiatorTaxId":"","method":"manual","receiverAccountNumber":"00000","receiverAccountType":"checking","receiverBankCode":"20018183","receiverBranchCode":"0001","receiverKeyId":"","receiverName":"Arya Stark","receiverTaxId":"012.345.678-90","reconciliationId":"","senderAccountNumber":"00000","senderAccountType":"checking","senderBankCode":"35547753","senderBranchCode":"0000","senderName":"jamie Lannister","senderTaxId":"594.739.480-42","status":"created","tags":["lannister","chargeback"],"updated":"2022-05-17T18:58:38.092426+00:00"}]}