GET
/
api
/
v1
/
accounts
List Accounts with Filtering
curl --request GET \
  --url http://localhost:8080/api/v1/accounts
[
  {
    "account_name": "<string>",
    "account_number": "<string>",
    "available_balance": "1000.50",
    "client_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "currency": "<string>",
    "current_balance": "1000.50",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "opened_date": "2023-11-07T05:31:56Z",
    "reserved_balance": "0.00",
    "updated_at": "2023-11-07T05:31:56Z",
    "closed_date": "2023-11-07T05:31:56Z",
    "daily_limit": "10000.00",
    "description": "<string>",
    "external_account_id": "<string>",
    "last_activity_date": "2023-11-07T05:31:56Z",
    "monthly_limit": "50000.00",
    "yearly_limit": "500000.00"
  }
]

Query Parameters

​
limit
integer<int64> | null
​
offset
integer<int64> | null
​
client_id
string<uuid> | null
​
account_type
null | enum<string>

Account Type - Different types of accounts that can be created

Available options:
CURRENT,
SAVINGS,
ESCROW
​
status
null | enum<string>

Account Status - Current status of the account

Available options:
PENDING,
ACTIVE,
SUSPENDED,
CLOSED
​
currency
string | null
​
search
string | null

Response

List of accounts

​
account_name
string
required
​
account_number
string
required
​
account_type
enum<string>
required

Account Type - Different types of accounts that can be created

Available options:
CURRENT,
SAVINGS,
ESCROW
​
available_balance
string
required
Example:

"1000.50"

​
client_id
string<uuid>
required
​
created_at
string<date-time>
required
​
currency
string
required
​
current_balance
string
required
Example:

"1000.50"

​
id
string<uuid>
required
​
opened_date
string<date-time>
required
​
reserved_balance
string
required
Example:

"0.00"

​
status
enum<string>
required

Account Status - Current status of the account

Available options:
PENDING,
ACTIVE,
SUSPENDED,
CLOSED
​
updated_at
string<date-time>
required
​
closed_date
string<date-time> | null
​
daily_limit
string | null
Example:

"10000.00"

​
description
string | null
​
external_account_id
string | null
​
last_activity_date
string<date-time> | null
​
monthly_limit
string | null
Example:

"50000.00"

​
yearly_limit
string | null
Example:

"500000.00"