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 amount (in cents) being held. |
| status | string | Status of the hold: Active, Released, or PartiallyReleased. |
| description | string | Description of the account hold. |
| expiredAt | RFC3339 Date string | The date the hold will be automatically released, if one was set. |
| tags | object | See Tags. |