Skip to main content

Create a Pix Transfer Batch

POST 
/v2/transfer/pix_batches

This endpoint is used to generate a pix transfer batch.

Prerequisite​

To issue a transfer batch it is necessary to have a Financial Account, specified in financial_account_uid. The transfer account applied to the batch is defined in transfer_account_uid; if omitted, the oldest one linked to the financial account is used; if provided, it must belong to financial_account_uid.

Webhook Events​

The transfer.batch.db.created event is triggered in this operation.

When registering a Transfer Batch, the system creates a command to register it with the financial institution. After the batch registration is confirmed at the institution, the transfer.pix_batch.confirmed event is triggered.

The transfer.db.created event is also triggered in this operation if the batch contains a new transfer.

Request​

Responses​

Pix Transfer Batch created