Pular para o conteúdo principal

Criar uma Transferência Pix

POST 
/v2/transfer/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.

Recebedor​

beneficiary.name e beneficiary.document_number (CPF/CNPJ) são obrigatórios para qualquer type, inclusive key, e para qualquer banco. A chave Pix não dispensa esses dados; sem eles, a API responde 422.

O 422 vem com param: "target" e detail: "Dados de destino Beneficiário não pode ficar em branco", o mesmo quando falta o nome ou o documento: o erro não traz um param por campo do recebedor.

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.

Request​

Responses​

Transferência Pix criada