Criar uma Transferência Pix

Esse endpoint é utilizado para a geração de uma transferência Pix.

Pré-requisito

Para emitir uma transferência é necessário ter uma Conta Financeira, informada em financial_account_uid. A conta de transferência que registra a operação é 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.db.created é disparado nesta operação.

Próximos passos: Após criar uma transferência, você desejará em algum momento enviar um Lote para a instituição financeira. Para isso, utilize o endpoint POST /api/v2/transfer/pix_batches.

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

Parametros para criação de uma Transferência Pix

Nova Transferência Pix

float
required

Quantia

date | null

Data de Agendamento

string | null

Objetivo da Transferência

uuid
required

UID da Conta Financeira de Origem

uuid | null

Conta de transferência de origem (opcional). Se omitida, usa-se a mais antiga da conta financeira. Se informada, deve pertencer à financial_account_uid.

string | null

ID no seu sistema. Opcional para controle interno.

custom_data
object | null

Hash com chave e valor no formato JSON.

tags
array of strings | null

Tags associadas

tags
beneficiary
object
required

Dados do Recebedor

string
required

Tipo do Pix

key: Chave.
bank_account: Dados bancários

string

Tipo da Chave (Obrigatório se o campo type for key)

cpf: CPF.
cnpj: CNPJ.
random: Aleatória.
email: E-mail.
phone: Celular

string

Chave Pix (Obrigatório se o campo type for key)

bank_account
object

Dados bancários (Obrigatório se o campo type for bank_account)

string | null

Identificação do pagamento no comprovante do provedor financeiro. (Uso exclusivo do banco)

Bancos que aceitam esse campo (via API): Itaú

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