Release of Guaranteed Funds
The release of guaranteed funds consists of ending the retention of a charge in the Escrow Account, making the amount available in the subaccount's balance.
While the guarantee remains active, the amount stays blocked and cannot be used by the subaccount. Once it is released, the funds become part of the available balance.
Release methods
Guaranteed funds can be released in three ways:
Automatic release
When the date defined in expirationDate is reached, the guarantee is automatically terminated and the amount becomes available in the subaccount's balance.
This process occurs automatically without requiring any action from the integration.
Manual release via API
If it is necessary to make the amount available before the end of the guarantee period, the integration can manually release it using the dedicated Escrow Account endpoint.
Before doing so, you must retrieve the guarantee information using the Retrieve Escrow Guarantee for a Charge endpoint, as it returns the guarantee identifier (id) required to finalize the guarantee.
After obtaining this identifier, use:
POST
/v3/escrow/{id}/finish
See the complete endpoint reference.
The parameter used in the URL corresponds to the Escrow Account guarantee identifier, not the charge identifier.
AttentionManual release immediately terminates the guarantee, regardless of the date configured in
expirationDate.After this operation, the amount is no longer retained and becomes part of the subaccount's available balance.
Release when disabling the Escrow Account
When the Escrow Account is disabled for a subaccount, all existing guarantees are automatically terminated and their respective amounts become available in the balance.
This behavior occurs regardless of the remaining time until the guarantee expires.
Example flow
A typical release flow works as follows:
Charge received
↓
Amount remains under guarantee
↓
Retrieve the charge guarantee
↓
Obtain the guarantee ID
↓
POST /v3/escrow/{id}/finish
↓
Guarantee terminated
↓
Amount available in the balanceOperational impact
After the guarantee is released:
- the amount is no longer blocked;
- the subaccount's available balance is updated;
- the platform may treat the funds as available for use, transfer, or withdrawal.
For this reason, it is recommended that the integration properly monitor the status of guarantees before considering an amount available for financial reconciliation.
Best practices
When implementing manual guarantee releases, it is recommended to:
- always retrieve the latest guarantee identifier before requesting its termination;
- use manual release only when it is actually necessary to make the balance available earlier;
- avoid sending multiple termination requests for the same guarantee;
- consider that, after the release, the period defined in
expirationDateno longer applies to that guarantee.
If your platform's strategy is to wait for the retention period to end normally, there is no need to make any API calls, as the release will occur automatically.
Updated 17 days ago
