Disabling the Escrow Account

Disable the Escrow Account when a subaccount no longer needs to hold new receipts under guarantee.

Disabling also starts the release of all existing guarantees of the subaccount.

❗️
Important
When you disable the Escrow Account for a subaccount, all amounts still under guarantee will be released.
This operation is irreversible. Once the release of guarantees has started, the Escrow Account can only be enabled again for this subaccount when all existing guarantees have been ended.

Before disabling

Use this flow only when the subaccount no longer needs to hold new receipts.

If the intention is only to wait for existing guarantees to expire, keep the Escrow Account enabled. The guarantees will be ended according to the configured release flow.

Disable a subaccount

Use the same Escrow Account configuration endpoint:

POST /v3/accounts/{id}/escrow

Set enabled to false and send the other fields required for the configuration.

{
"enabled": false,
"isFeePayer": true,
"daysToExpire": 10
}

The {id} parameter corresponds to the subaccount ID.

See the Save or update Escrow Account configuration for subaccount endpoint.

Expected result

A 200 OK response confirms that the configuration update was accepted.

From the moment it is disabled:

new charges and installments no longer enter the Escrow Account flow;
new receipts follow the subaccount's normal financial flow;
all existing guarantees enter the ending process;
held amounts are released to the subaccount's balance.

The release of guarantees occurs regardless of the remaining period until expirationDate.

The irreversibility applies to the guarantees that were ended: re-enabling the Escrow Account later does not restore these guarantees.

Disable for all subaccounts

🚧
Attention
You can also disable the Escrow Account for all subaccounts using the default configuration endpoint.
The behavior will be equivalent to the individual configuration.

Use:

POST /v3/accounts/escrow

When you set enabled to false, the default configuration is applied to existing subaccounts and will also be inherited by new subaccounts.

Since this operation may update a large number of subaccounts, it may take a few moments to complete.

See the Create default Escrow Account configuration for all subaccounts endpoint.

How to validate the configuration

To confirm the configuration of a subaccount:

GET /v3/accounts/{id}/escrow

See the Retrieve Escrow Account configuration for subaccount endpoint.

To confirm the default configuration:

GET /v3/accounts/escrow

See the Retrieve default Escrow Account configuration endpoint.

Use these queries for configuration validation or reconciliation, not for polling.

Important

Before disabling

Disable a subaccount

Expected result

Disable for all subaccounts

Attention

How to validate the configuration

Next steps