This endpoint is used to create outbound transfers to external accounts, either through TED or Pix, or directly to a Pix key.
Use this call when your application needs to move funds from an Asaas account out of the platform, whether to a traditional bank account or straight to a Pix key.
The transfer method depends on the data provided in the request:
- If
bankAccountis provided, the transfer will be made to a bank account - If
pixAddressKeyis provided, the transfer will be processed via Pix
If operationType is not provided, the system automatically determines the transfer type:
- Pix, if the destination institution is a Pix participant
- TED, otherwise
Main request parameters
Some fields determine how the transfer will be processed:
-
value: Amount to be transferred.
-
bankAccount: Object containing the destination bank account details. This should be used when the transfer is not being made to a Pix key.
-
operationType: Defines the transfer method:
PIXTED- If omitted, the type will be determined automatically.
-
pixAddressKey: Destination Pix key (
CPF,CNPJ, email, phone number, orEVP). -
pixAddressKeyType: Type of the Pix key provided:
CPFCNPJEMAILPHONEEVP
-
description: Transfer description. Available for Pix transfers.
-
scheduleDate: Scheduled transfer date. If not provided, the transfer is processed immediately.
-
externalReference: Identifier of the transfer in your own system.
-
recurring: Object that defines recurrence rules. Available only for Pix transfers.
Transfer behavior
Transfer processing varies depending on the transfer type:
-
Pix
- Can be processed instantly or scheduled
- Settlement happens in real time once processed
-
TED
- Depends on banking hours and banking rules
- May be processed on the same day or on the next business day
After creation, the transfer may go through statuses such as:
PENDINGDONECANCELLED
When to use
Use this endpoint when you need to:
- Transfer funds to external accounts
- Make payments to third parties
- Automate outbound financial disbursements outside Asaas
