Holds

A hold reserves part of an account's available balance without posting a transaction — useful for authorizing a payout before it settles. Holds are placed on an account and released by their own id.

Placing a hold

Holds are placed against an account, so placing and listing live under the account:

POST /api/v1/ledger/accounts/{id}/holds

Body takes currency, amount (integer string), and optional metadata. The engine reserves the amount against available balance and returns the hold (201). See Accounts for listing holds on an account.

Releasing a hold

Release is hold-scoped, so it lives under the hold:

POST /api/v1/ledger/holds/{id}/release

Body optionally takes amount — omit it to release the hold in full, or pass an amount to release part of it (a partial release leaves the remainder reserved). Returns the updated hold.

Next

• Transactions — committing a movement.
• Export — auditing balances and history.