Skip to main content
The Bank Accounts API allows you to create, update, delete, and retrieve bank account information.

​
getAll

Retrieve all bank accounts for the authenticated user. 
await client.bankAccounts.getAll()

​
Parameters

No parameters required.

​
Response

Returns an array of bank account objects.
​
id
string
Bank account ID
​
name
string
Account name
​
type
enum
Account type: CHECKING, CREDIT, INVESTMENT, or SAVINGS
​
balance
string
Current account balance
​
currency
string
Currency code (e.g., “USD”, “EUR”)
​
createdAt
Date
Creation timestamp
​
updatedAt
Date
Last update timestamp

​
create

Create a new bank account. 
await client.bankAccounts.create({
  name: "Chase Checking",
  type: "CHECKING",
  balance: "1000.00",
  currency: "USD"
})

​
Parameters

​
name
string
required
Account name
​
type
enum
required
Account type: CHECKING, CREDIT, INVESTMENT, or SAVINGS
​
balance
string
Initial account balance (defaults to “0”)
​
currency
CurrencyCode
required
Currency code (e.g., “USD”, “EUR”, “GBP”)

​
Response

​
id
string
Created bank account ID
​
name
string
Account name
​
type
string
Account type
​
balance
string
Account balance
​
currency
string
Currency code
​
createdAt
Date
Creation timestamp
​
updatedAt
Date
Last update timestamp

​
update

Update an existing bank account. 
await client.bankAccounts.update({
  id: "account-id",
  name: "Chase Premium Checking",
  type: "CHECKING",
  balance: "1500.00"
})

​
Parameters

​
id
string
required
Bank account ID to update
​
name
string
Updated account name
​
type
enum
Updated account type: CHECKING, CREDIT, INVESTMENT, or SAVINGS
​
balance
string
Updated account balance
The currency field cannot be updated after creation.

​
Response

Returns the updated bank account object.

​
delete

Delete a bank account. 
await client.bankAccounts.delete({
  id: "account-id"
})

​
Parameters

​
id
string
required
Bank account ID to delete

​
Response

Returns the deleted bank account object.
Deleting a bank account will cascade delete all associated transactions.

​
TypeScript Types

type BankAccountType = "CHECKING" | "CREDIT" | "INVESTMENT" | "SAVINGS"

type BankAccount = {
  id: string
  name: string
  type: BankAccountType
  balance: Intl.StringNumericLiteral
  currency: CurrencyCode
  userId: string
  createdAt: Date
  updatedAt: Date
}

​
Constraints

  • Account name, type, and user combination must be unique
  • Account name cannot be empty
  • Balance defaults to “0” if not provided
  • Currency defaults to “USD” if not provided

Build docs developers (and LLMs) love

Get started for freeTalk to us