Create default Escrow Account configuration for all subaccounts


Creates or updates the default Escrow Account configuration for the subaccounts linked to the main account.

Use this operation when the subaccounts should use the same configuration. The configuration is applied to existing subaccounts and automatically inherited by new subaccounts.

The Escrow Account can be configured directly by the main account, without needing to request prior enablement from Asaas.

⚠️

Applying the configuration

Applying the new configuration to existing subaccounts may take a few moments, depending on the number of subaccounts linked to the main account.

Do not assume that all subaccounts have already been updated immediately after the operation response.

❗️

Disabling

When setting enabled to false, new payments and installments of existing subaccounts no longer enter the Escrow Account flow and existing escrows go through the finishing process, with release of the retained amounts.

Enabling it again later does not restore escrows that have already been finished.

See the Escrow Account disabling flow.

To retrieve the registered default configuration, use Retrieve default Escrow Account configuration.

Related content

Guides

Body Params
int32
required

Number of days to expire the payment escrow

boolean

Indicates whether the Escrow Account is enabled

boolean

Indicates whether the subaccount is responsible for paying the Escrow Account fee. If not informed, the main account will be responsible for the fee

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json