Perform Pix Batch Transaction

QI Tech offers the possibility of performing multiple Pix transactions with a single call. In this system, transactions are carried out asynchronously. If an http status 4xx is returned in the initial call, none of the transactions will be executed. After the request, the integrator partner will receive a webhook for each transaction informing the final status of the attempt, which can be rejected or sent.

Request

ENDPOINT

/account/ACCOUNT_KEY/pix_transfer_batch

METHOD

POST

{
  "request_control_key": "6e4fc980-f8a1-4462-b6e2-d8a49f0ac055",
  "pix_transfers": [
    {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "pix_transfer_type": "key",
      "target_pix_key": "target_pix_key@email.com",
      "transaction_amount": 500.65,
      "end_to_end_id": "E73856642202309201429bZKfklNlbwu",
      "pix_message": "Hello World!"
    },
    {
      "request_control_key": "5fb20e2e-78e3-4ca7-bb36-515640ec2e78",
      "pix_transfer_type": "manual",
      "target_account": {
        "account_branch": "0001",
        "account_digit": "3",
        "account_number": "12345678",
        "owner_document_number": "32402502000135",
        "owner_name": "Qi Tech",
        "account_type": "checking_account",
        "ispb": "32402502"
      },
      "transaction_amount": 500.65,
      "pix_message": "Hello World!"
    },
    {
      "request_control_key": "10ad6e08-1a4c-403c-8122-178b0acf1dfa",
      "pix_transfer_type": "static_qr_code",
      "transaction_amount": 500.65,
      "end_to_end_id": "E73856642202309201429bZKfklNlbrb",
      "receiver_conciliation_id": "REC00000000000000000000009459463343",
      "target_pix_key": "target_pix_key@email.com",
      "pix_message": "Hello World!"
    }
  ]
}

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique identification key of the account.	36

Body Params

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format.	36
pix_transfers *	array	List of pix_transfer objects linked to the batch.	list of Object pix_transfer

Object pix_transfer

Field	Type	Description	Characters
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format.	36
pix_transfer_type *	enumerator	Type of pix to be performed.	Enumerator pix_transfer_type
target_pix_key	string	Pix key of the account to which the transaction will be sent.	100
target_account	Object	Destination account - Should only be sent in transfers with pix_transfer_type of type manual.	Object target_account
receiver_conciliation_id	string	Receiver's conciliation identification.	35
transaction_amount *	number	Transfer amount.	10
end_to_end_id	string	Idempotency key of a Pix transaction within the SPI (Instant Payment System). This key is returned in the Pix key query. Should only be sent if the pix_transfer_type is key, static_qr_code, or dynamic_qr_code	32
pix_message	string	Message to be sent along with the Pix transfer.	140

Object target_account

Field	Type	Description	Characters
account_branch *	string	Branch of the account.	6
account_digit *	string	Account digit.	1
account_number *	string	Account number.	20
owner_document_number *	string	CPF or CNPJ (numbers only) of the account holder.	14
owner_name *	string	Name of the account holder.	150
account_type *	enumerator	Type of account.	Enumerator account_type
ispb *	string	Based on the financial institution's CNPJ (8 digits).	8

Enumerator account_type

Enumerator	Description
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Enumerator pix_transfer_type

Enumerator	Description
manual	Pix using the destination account details. Required to send target_account
key	Pix using a pix key. Required to send target_pix_key. Recommended to send end_to_end_id from the Pix key query if it has been performed
static_qr_code	Pix using a static QR code. Required to send the end_to_end_id returned in the QR code decoding
dynamic_qr_code	Pix using a dynamic QR code. Required to send the end_to_end_id returned in the QR code decoding

Response

STATUS

201

Response Body: Batch Transfer Approved

{
  "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
  "pix_transfer_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "pix_transfer_batch_status": "approved"
}

Enumerator pix_transfer_batch_status

Enumerator	Description
approved	Batch transfer approved and transactions in execution process.
rejected	Batch transfer rejected
pending_2fa_approval	Batch transfer pending manual approval

STATUS

4xx

Response Body: Transfer Rejected

{
  "title": "title",
  "description": "description in English",
  "translation": "description in Portuguese",
  "code": "code",
  "extra_fields": {
    "pix_transfer_batch_data": {
      "request_control_key": "b6804f32-101e-4702-8fbc-c2dbc4c2caec",
      "pix_transfer_batch_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
      "pix_transfer_batch_status": "rejected"
    }
  }
}

STATUS

4xx

Response Body: Error

{
  "title": "title",
  "description": "description in English",
  "translation": "description em Portuguese",
  "code": "code",
  "extra_fields": {}
}

Information

The errors previously listed for Pix transfer may be returned by this endpoint.