Endpoint responsável por criar transferências de valores para contas externas (via TED ou Pix) ou para chaves Pix.

Essa chamada é utilizada quando sua aplicação precisa movimentar saldo da conta Asaas para fora da plataforma, seja para contas bancárias tradicionais ou diretamente para uma chave Pix.

A forma de envio da transferência depende dos dados informados na requisição:

• Ao informar bankAccount, a transferência será feita para uma conta bancária
• Ao informar pixAddressKey, a transferência será feita via Pix

Caso o campo operationType não seja informado, o sistema define automaticamente o tipo da transferência:

• Pix, quando a instituição de destino for participante
• TED, caso contrário

Parâmetros principais da requisição

Alguns campos determinam o comportamento da transferência:

• value: Valor a ser transferido.

• bankAccount: Objeto com os dados da conta bancária de destino. Deve ser utilizado quando a transferência não for via chave Pix.

• operationType: Define a modalidade da transferência:

  • PIX
  • TED
  • Caso não informado, o tipo será definido automaticamente.

• pixAddressKey: Chave Pix de destino (CPF, CNPJ, e-mail, telefone ou EVP).

• pixAddressKeyType: Tipo da chave Pix informada:

  • CPF
  • CNPJ
  • EMAIL
  • PHONE
  • EVP

• description: Descrição da transferência (disponível para Pix).

• scheduleDate: Data de agendamento da transferência. Quando não informado, a transferência é realizada imediatamente.

• externalReference: Identificador da transferência no seu sistema.

• recurring: Objeto que define regras de recorrência. Disponível apenas para transferências via Pix.

Comportamento da transferência

O processamento da transferência varia conforme o tipo:

• Pix

  • Pode ser instantâneo ou agendado
  • Liquidação ocorre em tempo real após processamento

• TED

  • Depende do horário e regras bancárias
  • Pode ser processado no mesmo dia ou próximo dia útil

Após a criação, a transferência passa por estados como:

• PENDING
• DONE
• CANCELLED

Quando utilizar

Utilize este endpoint quando for necessário:

• Transferir saldo para contas externas
• Realizar pagamentos a terceiros
• Automatizar repasses financeiros fora do Asaas

Regra importante sobre Pix recorrente

Ao utilizar o objeto recurring, a transferência será configurada como uma recorrência via Pix dentro do fluxo de transferências.

Esse fluxo não retorna QR Code para pagamento. O objetivo dessa chamada é agendar ou recorrenciar uma transferência Pix já definida pela sua integração, e não criar uma cobrança Pix para pagamento por leitura de QR Code.

Se sua necessidade for gerar um QR Code para que o pagador realize um pagamento Pix, utilize o fluxo de cobranças Pix ou o fluxo específico de Pix Automático, conforme o seu cenário de integração.

🚧

Atenção

Saiba mais sobre Pix recorrente clicando aqui.

O uso do objeto recurring neste endpoint permite configurar uma transferência Pix recorrente.
Esse fluxo não disponibiliza QR Code. Se o seu objetivo for gerar um QR Code para pagamento, consulte a documentação de cobranças Pix ou Pix Automático, de acordo com o cenário.