Criar um Lote de Transferência Pix

Esse endpoint é utilizado para a geração de um lote de transferência pix.

Pré-requisito

Para emitir um lote de transferência é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de transferência aplicada ao lote é definida em transfer_account_uid; se omitida, usa-se a mais antiga vinculada à conta financeira; se informada, deve pertencer à financial_account_uid.

Eventos de Webhook

O evento transfer.batch.db.created é disparado nesta operação.

Ao cadastrar um Lote de Transferência, o sistema cria um comando para registrá-lo na instituição financeira. Após o registro do lote ser confirmado na instituição, o evento transfer.pix_batch.confirmed é disparado.

O evento transfer.db.created também é disparado nesta operação caso o lote contenha uma nova transferência.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parametros para criação de um Lote de Transferência Pix

uuid
required

UID da Conta Financeira de Origem

uuid | null

Conta de transferência aplicada a todo o lote (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à conta financeira do lote.

transfers
array
required

Lista de Transferências Pix novas ou existentes.

transfers*
Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json