Bank Account

List all bank accounts

GET/bank-accounts

List all bank accounts under the platform. Filtered results can be retrieved with extra parameters in the query.

Query Parameters

balance.gt

numberOptional

Return results where the balance is greater than this value (in smallest currency unit).

balance.gte

numberOptional

Return results where the balance is greater than or equal to this value (in smallest currency unit).

balance.lt

numberOptional

Return results where the balance is less than this value (in smallest currency unit).

balance.lte

numberOptional

Return results where the balance is less than or equal to this value (in smallest currency unit).

bank_account_ids

stringOptional

Comma-separated list of bank account IDs to filter by.

created.gt

date-timeOptional

Return results where the created_at field is greater than this value.

created.gte

date-timeOptional

Return results where the created_at field is greater than or equal to this value.

created.lt

date-timeOptional

Return results where the created_at field is less than this value.

created.lte

date-timeOptional

Return results where the created_at field is less than or equal to this value.

description

stringOptional

Filter bank accounts by description.

ending_before

stringOptional

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo, your subsequent call can include ending_before=foo_ZXhhbXBsZQo in order to fetch the previous page of the list.

entity_id

stringOptional

List all accounts that belong to the entity with the given entity_id.

is_overdraftable

booleanOptional

List all accounts that are overdraftable.

limit

numberOptional

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

overdraft_reserve_account_id

stringOptional

List all bank accounts with the given overdraft_reserve_account_id.

query

stringOptional

Search query to match against bank accounts.

sort

stringOptional

Field to sort results by.

sort_order

stringOptional

Sort direction. Can be asc or desc.

starting_after

stringOptional

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.

type

stringOptional

Bank account type. Can be CHECKING, OVERDRAFT_RESERVE, PROGRAM_RESERVE, or NETWORK_SETTLEMENT_ACCOUNT.