BankAccount

List all bank accounts

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

get/bank-accounts

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/bank-accounts
  • Auth: HTTP basic

Query parameters

balance.gtinteger

Return results where the balance is greater than this value, in the smallest unit of currency_code. When currency_code is omitted, the value is interpreted with two decimal digits and applied across all currencies.

balance.gteinteger

Return results where the balance is greater than or equal to this value, in the smallest unit of currency_code. When currency_code is omitted, the value is interpreted with two decimal digits and applied across all currencies.

balance.ltinteger

Return results where the balance is less than this value, in the smallest unit of currency_code. When currency_code is omitted, the value is interpreted with two decimal digits and applied across all currencies.

balance.lteinteger

Return results where the balance is less than or equal to this value, in the smallest unit of currency_code. When currency_code is omitted, the value is interpreted with two decimal digits and applied across all currencies.

created.gtstring date-time

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

created.gtestring date-time

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

created.ltstring date-time

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

created.ltestring date-time

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

currency_codestring

Filter bank accounts by their three-letter ISO 4217 currency code. When omitted, accounts in all currencies are returned; if balance.* filters are also set, their amounts are interpreted with two decimal digits and applied across all currencies, so pass currency_code for exact filtering on currencies with other decimal counts.

descriptionstring

Filter bank accounts by description.

ending_beforestring

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_idstring

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

is_overdraftableboolean

List all accounts that are overdraftable.

limitinteger

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

overdraft_reserve_account_idstring

List all bank accounts with the given overdraft_reserve_account_id.

querystring

Search query to match against bank accounts.

sortstring

Field to sort results by.

sort_orderstring

Sort direction. Can be asc or desc.

starting_afterstring

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.

statusstring

Filter bank accounts by status. Can be open, closed, or frozen.

typestring

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

Response

Successful response

has_moreboolean required

Whether more bank accounts are available

Changes

No recorded changes to this operation across all 1 revision of this API.