getAll
Retrieve all bank accounts for the authenticated user.Parameters
No parameters required.Response
Returns an array of bank account objects.string
Bank account ID
string
Account name
enum
Account type:
CHECKING, CREDIT, INVESTMENT, or SAVINGSstring
Current account balance
string
Currency code (e.g., “USD”, “EUR”)
Date
Creation timestamp
Date
Last update timestamp
create
Create a new bank account.Parameters
string
required
Account name
enum
required
Account type:
CHECKING, CREDIT, INVESTMENT, or SAVINGSstring
Initial account balance (defaults to “0”)
CurrencyCode
required
Currency code (e.g., “USD”, “EUR”, “GBP”)
Response
string
Created bank account ID
string
Account name
string
Account type
string
Account balance
string
Currency code
Date
Creation timestamp
Date
Last update timestamp
update
Update an existing bank account.Parameters
string
required
Bank account ID to update
string
Updated account name
enum
Updated account type:
CHECKING, CREDIT, INVESTMENT, or SAVINGSstring
Updated account balance
The currency field cannot be updated after creation.
Response
Returns the updated bank account object.delete
Delete a bank account.Parameters
string
required
Bank account ID to delete
Response
Returns the deleted bank account object.TypeScript Types
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