List all bank accounts
List all bank accounts under the platform. Filtered results can be retrieved with extra parameters in the query.
Request
- Base URL: https://api.column.com
- URL: https://api.column.com/bank-accounts
- Auth: HTTP basic
Query parameters
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.
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.
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.
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.
Return results where the created_at field is greater than this value.
Return results where the created_at field is greater than or equal to this value.
Return results where the created_at field is less than this value.
Return results where the created_at field is less than or equal to this value.
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.
Filter bank accounts by description.
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.
List all accounts that belong to the entity with the given entity_id.
List all accounts that are overdraftable.
A limit on the number of objects to be returned, between 1 and 100. The default is 10.
List all bank accounts with the given overdraft_reserve_account_id.
Search query to match against bank accounts.
Field to sort results by.
Sort direction. Can be asc or desc.
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.
Filter bank accounts by status. Can be open, closed, or frozen.
Bank account type. Can be CHECKING, OVERDRAFT_RESERVE, PROGRAM_RESERVE, or NETWORK_SETTLEMENT_ACCOUNT.
Response
Successful response
Changes
No recorded changes to this operation across all 1 revision of this API.