Resources

This page documents the JSON:API resource schema related to account holds.

AccountHold

The AccountHold resource represents a temporary reservation of funds in a deposit account's balance, making that amount unavailable for other transactions while the hold is active.

For the complete resource schema including all attributes and relationships, see AccountHold.

Key Attributes

Attribute	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
updatedAt	RFC3339 Date string	The date the resource was last updated.
amount	integer	The original amount (in cents) of the hold.
remainingHoldAmount	integer	Optional. The remaining amount (in cents) still being held. Only present when status is PartiallyReleased.
status	string	Status of the hold: Active, PartiallyReleased, or Released.
description	string	Optional. Description of the account hold (maximum of 80 characters).
expiredAt	RFC3339 Date string	Optional. The date the hold will be automatically released, if one was set.
releasedAt	RFC3339 Date string	Optional. The date the hold was fully released. Only present when status is Released.
tags	object	Optional. See Tags.