Account Holds
An AccountHold temporarily reserves a specified amount of funds in a deposit account's balance, making that amount unavailable for other transactions. While the hold reduces the deposit account's available balance, the held funds remain in the deposit account and are not moved — the deposit account's total balance stays unchanged.
When creating an AccountHold, the specified hold amount is deducted from the Deposit Account's available field and added to its hold field.
Account Hold Statuses
| Status | Description |
|---|---|
Active | The hold is in effect and its full amount is reserved. |
PartiallyReleased | A portion of the hold amount has been released; the remainder is still reserved. |
Released | The hold has been fully released (either by an explicit full release, a partial release completing the full amount, or automatic release at expiry) and no amount remains reserved. |
Releasing Holds
An account hold can be released in two ways:
- Fully: the entire remaining hold amount is released at once, no request body required.
- Partially: a specified portion of the hold amount is released, leaving the rest active.
Holds can also carry an optional expiredAt date, after which they are automatically released.
Related Resources
- APIs - Create, release, get, and list account holds
- Webhook Events - Webhook events for account hold lifecycle changes
- Resources - JSON:API resource schema