Enabling the Escrow Account for Subaccounts
Use the API to configure the Escrow Account for your subaccounts. This can be done by configuring an individual subaccount or by creating a default configuration that will be applied to all subaccounts.
After enabling the Escrow Account for a subaccount, all new charges and installment payments received by that subaccount will follow the fund retention flow for the configured period.
Prerequisites
Before configuring the Escrow Account for a subaccount, make sure that:
- the Escrow Account feature is available for your account;
- the subaccount has already been created in Asaas;
- you have the subaccount identifier (
id) that will be configured.
If the Escrow Account feature is not available for your account, it will not be possible to enable it for your subaccounts.
Configuring a subaccount
POST
/v3/accounts/{id}/escrow
See the complete reference for this endpoint
{
"enabled": true,
"isFeePayer": true,
"daysToExpire": 10
}
AttentionWhen creating or updating the configuration with the enabled status for a subaccount, only charges and installment payments received after this configuration will be submitted to the Escrow Account fund retention flow.
Previous payments remain unchanged.
See also the Funds under Escrow Account guarantee section.
Available settings
The fields have the following purposes:
enabled — Defines whether the Escrow Account will be enabled for the subaccount.
When set to true, new payments will begin following the fund retention flow.
When set to false, new charges will no longer enter the Escrow Account flow.
isFeePayer — Defines who will be responsible for paying the Escrow Account monthly fee.
true: the monthly fee will be charged to the subaccount itself.false(or if the field is omitted): the fee will be charged to the main account.
daysToExpire — Defines how many days the funds will remain blocked before being released automatically.
During this period, the funds remain under guarantee and are not available in the subaccount balance.
ImportantThe period specified in
daysToExpirewill apply to new payments processed after the Escrow Account configuration.
Default configuration for all subaccounts
You can also create a default configuration so that new subaccounts automatically use the same settings for:
- Escrow Account enablement;
- monthly fee payer;
- retention period (
daysToExpire).
If you want to automatically replicate these settings to all existing subaccounts, contact Asaas Support.
ImportantWhen the Escrow Account is enabled for a subaccount, the monthly fee will be charged on the day following activation.
Subsequent charges will occur monthly while the feature remains enabled.
See also the Monthly fee charged per configured subaccount section.
Best practices
Before enabling the Escrow Account for a subaccount, it is recommended to:
- verify whether the subaccount should actually use fund retention;
- carefully define the retention period (
daysToExpire), as it directly impacts when the balance will become available; - configure who will be responsible for paying the feature's monthly fee;
- perform tests in the Sandbox environment before enabling the feature in Production.
These precautions help prevent unexpected impacts on the financial flow of your subaccounts.
Updated 17 days ago
