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

Authorizations

api-key
string
header
required

Response

200 - application/json
id
string
required
currency
object
required
account_number
string
required
Maximum length: 255
bank_info
string
required
created_at
string
required
updated_at
string
required
user
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 - 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 length: 255
account_name
string | null
Maximum 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 - Default
  • ACTIVE - Active
  • INACTIVE - Inactive
  • DORMANT - Dormant
  • CLOSED - Closed
  • ESCHEAT - Escheat
  • CHARGEOFF - Chargeoff
Available options:
NULL,
ACTIVE,
INACTIVE,
DORMANT,
CLOSED,
ESCHEAT,
CHARGEOFF