Getting a List of Accounts

Gathering a list of a customer’s financial accounts is required to do many functions, including checking balances and creating transfers. The list of accounts can be gathered by calling the listAccounts operation.

listAccounts operation

The listAccounts operation returns a list of all accounts the customer is entitled to view at the financial institution. The list includes account IDs, names and other descriptive information.

To use the listAccounts operation, perform GET request against:

/banking/accounts

Filters can be used to reduce the number of accounts returned. The accounts can be filtered by the location of the account and the types of transactions that the account allows. For more information on account filtering, see the API documentation and the documentation on how to use filtering.

The response may contain a large list of accounts. Although a customer may have access to many accounts, a limited number of accounts are returned at one time. This smaller subset of accounts is called a page.

More accounts can be viewed by loading the next page. Using these pages of data is referred to as pagination and is further explained in the Collection Pagination documentation. For a tutorial, see Using Pagination.