Resources

This page documents the JSON:API resource schemas related to deposit accounts.

DepositAccount

The DepositAccount resource represents a bank account maintained by a financial institution where customers can deposit and withdraw money.

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

Key Attributes

Attribute	Type	Description
createdAt	RFC3339 Date string	The date the resource was created.
name	string	Name of the account holder.
status	string	Status of the account: Open, Frozen, or Closed.
depositProduct	string	The name of the deposit product.
routingNumber	string	Routing number, together with the account number form the identifier of the account on the ACH network.
accountNumber	string	Account number, together with the routing number form the identifier of the account on the ACH network.
balance	integer	The balance amount (in cents).
available	integer	The available balance for spending (in cents).
hold	integer	The amount that is held (in cents).
tags	object	See Tags.

---

AccountHold

The AccountHold resource represents a temporary reservation of funds in an account 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	Optional. The date the hold will be automatically released.
tags	object	See Tags.

---

AccountEndOfDay

The AccountEndOfDay resource represents an account's balance at the end of a business day. This is useful for tracking balance history over time and creating balance charts.

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

Key Attributes

Attribute	Type	Description
date	ISO Local Date string	The date of the end-of-day balance.
balance	integer	The account balance (in cents) at the end of the day.
available	integer	The available balance (in cents) at the end of the day.
hold	integer	The held amount (in cents) at the end of the day.