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

List Bank Accounts

cURL

curl --request GET \
  --url https://api.example.com/banking/v1/bank_accounts/ \
  --header 'api-key: <api-key>'

200

[
  {
    "id": "<string>",
    "currency": {
      "id": "<string>",
      "name": "<string>",
      "code": "<string>",
      "symbol": "<string>"
    },
    "account_number": "<string>",
    "bank_info": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "user": 123,
    "title": "<string>",
    "classification": "NULL",
    "type": "NULL",
    "reference": "<string>",
    "account_name": "<string>",
    "business_name": "<string>",
    "current_balance": "<string>",
    "product_type": "<string>",
    "credit_limit": "<string>",
    "transaction_count": "<string>",
    "status": "NULL"
  }
]

Authorizations

api-key · string · header · required

Response

200 - application/json

id · string · required

currency · object · required

Show child attributes

account_number · string · required

Maximum string length: 255

bank_info · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

user · integer | null

title · string | null

Optional title of the account.

Maximum string length: 255

classification

indicate the classification of the account as personal, business or other wise

• NULL - Default
• PERSONAL - Personal
• BUSINESS - Business

Available options: NULL, PERSONAL, BUSINESS

type

• NULL - Default
• SAVINGS - Savings
• CURRENT - Current
• DEPOSIT - Deposit

Available options: NULL, SAVINGS, CURRENT, DEPOSIT

reference · string | null

Maximum string length: 255

account_name · string | null

Maximum string length: 255

business_name · string | null

Maximum string length: 255

current_balance · string | null

product_type · string | null

credit_limit · string | null

transaction_count · string | null

status

• NULL - Default
• ACTIVE - Active
• INACTIVE - Inactive
• DORMANT - Dormant
• CLOSED - Closed
• ESCHEAT - Escheat
• CHARGEOFF - Chargeoff

Available options: NULL, ACTIVE, INACTIVE, DORMANT, CLOSED, ESCHEAT, CHARGEOFF