Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Bank Accounts

Return the data for all BankAccounts

Outlines the parameters, optional and required, used when requesting the data for all BankAccounts

get/bank_accounts.json

Query parameters

created_sincestring date-time

Filter BankAccount records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

ids[]integer

Filter BankAccount records to those having the specified unique identifiers.

limitinteger

A limit on the number of BankAccount records to be returned. Limit can range between 1 and 200. Default: 200.

order'id(asc)' | 'id(desc)' | 'name(asc)' | 'name(desc)' | 'institution(asc)' | 'institution(desc)' | 'account_number(asc)' | 'account_number(desc)' | 'transit_number(asc)' | 'transit_number(desc)' | 'currency(asc)' | 'currency(desc)' | 'updated_at(asc)' | 'updated_at(desc)' | 'type(asc)' | 'type(desc)'

Orders the BankAccount records by the given field. Default: id(asc).

page_tokenstring

A token specifying which page to return.

show_empty_accountsboolean

Filter BankAccount records to those having a zero or non zero balance.

status'opened' | 'closed'

Filter BankAccount records to those having a specific status.

type'OperatingAccount' | 'TrustAccount'

Filter BankAccount records to those having a specific type.

updated_sincestring date-time

Filter BankAccount records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

user_idinteger

The unique identifier for a single User. Use the keyword null to match those without a BankAccount. The list will be filtered to include only the BankAccount records with the matching property.

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok