Accounts
Defined in: src/transactions/client.gen.ts:8
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Accounts(
_core):Accounts
Defined in: src/transactions/client.gen.ts:9
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Accounts
Methods
Section titled “Methods”get(
id,options?):Promise<{account_number:string;available_balance: {amount:number;currency:string|null; };current_balance: {amount:number;currency:string|null; };id:string;name:string;primary:boolean;routing_number:string;status?:"ACTIVE"|null; }>
Defined in: src/transactions/client.gen.ts:18
Get cash account by ID
This endpoint returns the cash account associated with the provided ID with its status.
GET /v2/accounts/cash/{id} — requires OAuth scope: accounts.cash.readonly
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ account_number: string; available_balance: { amount: number; currency: string | null; }; current_balance: { amount: number; currency: string | null; }; id: string; name: string; primary: boolean; routing_number: string; status?: "ACTIVE" | null; }>
getPrimary()
Section titled “getPrimary()”getPrimary(
options?):Promise<{account_number:string;available_balance: {amount:number;currency:string|null; };current_balance: {amount:number;currency:string|null; };id:string;name:string;primary:boolean;routing_number:string;status?:"ACTIVE"|null; }>
Defined in: src/transactions/client.gen.ts:36
Get primary cash account
This endpoint returns the primary cash account with its status. There will always be only one primary account.
GET /v2/accounts/cash/primary — requires OAuth scope: accounts.cash.readonly
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ account_number: string; available_balance: { amount: number; currency: string | null; }; current_balance: { amount: number; currency: string | null; }; id: string; name: string; primary: boolean; routing_number: string; status?: "ACTIVE" | null; }>
list()
Section titled “list()”list(
options?):Promise<{items:object[];next_cursor?:string|null; }>
Defined in: src/transactions/client.gen.ts:53
List cash accounts
This endpoint lists all the existing cash accounts with their status.
GET /v2/accounts/cash — requires OAuth scope: accounts.cash.readonly
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<{ items: object[]; next_cursor?: string | null; }>
listCard()
Section titled “listCard()”listCard(
options?):Promise<object[]>
Defined in: src/transactions/client.gen.ts:70
List card accounts
This endpoint lists all accounts of card type.
GET /v2/accounts/card — requires OAuth scope: accounts.card.readonly
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<object[]>
listCashStatements()
Section titled “listCashStatements()”listCashStatements(
id,query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/transactions/client.gen.ts:88
List cash account statements.
This endpoint lists all finalized statements for the cash account by ID.
GET /v2/accounts/cash/{id}/statements — requires OAuth scope: statements.cash.readonly
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”string
query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
limit?
Section titled “limit?”number | null
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>
listPrimaryCardStatements()
Section titled “listPrimaryCardStatements()”listPrimaryCardStatements(
query?,options?):PagePromise<{items:object[];next_cursor?:string|null; }>
Defined in: src/transactions/client.gen.ts:108
List primary card account statements.
This endpoint lists all finalized statements for the primary card account.
GET /v2/accounts/card/primary/statements — requires OAuth scope: statements.card.readonly
Await for a single page, or for await to iterate items across all pages.
Parameters
Section titled “Parameters”query?
Section titled “query?”cursor?
Section titled “cursor?”string | null
limit?
Section titled “limit?”number | null
options?
Section titled “options?”Returns
Section titled “Returns”PagePromise<{ items: object[]; next_cursor?: string | null; }>