Bank Accounts
List Bank Accounts
This Collection allows for interacting with Bank Accounts irrespective of their currency.
This is a readonly endpoint and if you must perform changes to the account access them from the currency based collections
GET
/
banking
/
v1
/
bank_accounts
/
Authorizations
api-key
string
headerrequiredResponse
200 - application/json
id
string
requireduser
integer | null
title
string | null
Optional title of the account.
Maximum length:
255
classification
indicate the classification of the account as personal, business or other wise
NULL
- DefaultPERSONAL
- PersonalBUSINESS
- Business
Available options:
NULL
, PERSONAL
, BUSINESS
type
NULL
- DefaultSAVINGS
- SavingsCURRENT
- CurrentDEPOSIT
- Deposit
Available options:
NULL
, SAVINGS
, CURRENT
, DEPOSIT
currency
object
requiredreference
string | null
Maximum length:
255
account_name
string | null
Maximum length:
255
account_number
string
requiredMaximum length:
255
business_name
string | null
Maximum length:
255
current_balance
string | null
product_type
string | null
credit_limit
string | null
transaction_count
string | null
status
NULL
- DefaultACTIVE
- ActiveINACTIVE
- InactiveDORMANT
- DormantCLOSED
- ClosedESCHEAT
- EscheatCHARGEOFF
- Chargeoff
Available options:
NULL
, ACTIVE
, INACTIVE
, DORMANT
, CLOSED
, ESCHEAT
, CHARGEOFF
bank_info
string
requiredcreated_at
string
requiredupdated_at
string
required