Escrow Account

Use the Escrow Account when your platform needs to control when amounts received by subaccounts will be made available in the balance.

The amounts can remain temporarily under guarantee and be released automatically after the configured period or manually by the platform.

How it works

%%{init: {"flowchart": {"nodeSpacing": 18,"rankSpacing": 24,"diagramPadding": 4,"padding": 7}}}%%
flowchart TD
A["Configure the Escrow Account"] --> B["Receive a charge or installment"]
B --> C["Keep the amount under guarantee"]
C --> D["End the guarantee"]
D --> E["Make the amount available in the balance"]

classDef inicio fill:#DBEAFE,stroke:#2563EB,color:#1E3A8A,stroke-width:3px
classDef validacao fill:#E0F2FE,stroke:#0284C7,color:#0C4A6E,stroke-width:2px
classDef sucesso fill:#DCFCE7,stroke:#16A34A,color:#14532D,stroke-width:3px

class A inicio
class B,C,D validacao
class E sucesso

linkStyle default stroke:#94A3B8,stroke-width:2px

The configuration is done per subaccount. The retention period, who pays the monthly fee, and how amounts are released depend on your platform's strategy.

Next steps

If you need to...See
Understand when to use the Escrow Account and its main rulesIntroduction - Escrow Account
Enable and configure the Escrow Account for subaccountsConfiguring the Escrow Account for subaccounts
Understand who pays the monthly fee and how the billing cycle worksFee charging per configured subaccount
Understand how receipts are held and look up a guaranteeFunds under Escrow Account guarantee
Release amounts automatically or end a guarantee manuallyRelease of guaranteed funds
Stop holding new receipts for a subaccountDisabling the Escrow Account

Did this page help you?