Enabling the Escrow Account for Subaccounts

To use the Escrow Account, you must contact support to have it enabled in your subaccount arrangement.

Once enabled, you can use the API to configure the Escrow Account for each subaccount. The example below demonstrates configuring the Escrow Account for a subaccount via API:

POST /v3/accounts/{id}/escrow
See the complete reference for this endpoint

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

🚧

Attention

When creating or updating the configuration with the enabled status for the subaccount, future charges and installments that are received will be subject to the blocking flow under the Escrow Account guarantee. See the value blocking section.

The fields define the following settings:

• enabled (Enabled/Disabled): Defines whether the Escrow Account is enabled for the specified subaccount.
• isFeePayer (Subaccount is the Escrow Account fee payer): If set to true, the Escrow Account monthly fee will be charged to the subaccount identified in the endpoint. If set to false or not provided, the fee will be charged to the main account.
• daysToExpire (Days to Expiration): Number of days that the amounts received in the subaccount will remain blocked under the Escrow Account guarantee before being automatically released.

You can also replicate the enabled/disabled settings, expiration days, and whether subaccounts are fee payers to all your subaccounts. To perform this replication automatically, simply contact support.

❗

Important!

When creating or updating the Escrow Account configuration with the enabled status, the monthly fee for this product will be charged the day after configuration. Subsequent charges will follow the monthly cycle. See the fee per configured subaccount section for more information.