List Accounts

---

Overview

You can retrieve all accounts that meet a requested criteria by using the List Account API.

Data Latency

Account List API will return data with a latency of 30 minutes.

---

Resource Access

Production (api.ahrvo.network)

POST https://api.ahrvo.network/banking/us2/v1/account/list

Staging (gateway.ahrvo.network)

POST https://gateway.ahrvo.network/banking/us2/v1/account/list

---

Authentication

Header	Description
Authorization	Bearer {JWT token}
x-api-key	Your API key
Content-Type	application/json

---

Supported Filter Criteria

The requested criteria can be a combination of one or more of the following fields:

Filter	Supported Operators
id	eq, ne, in, gt, gte, lt, lte
externalId	eq, ne, in
status	eq, in
createdOn	eq, gt, gte, lt, lte
createdBy	eq
lastUpdatedOn	eq, gt, gte, lt, lte
lastUpdatedBy	eq
owner.type	eq — Possible values: PROGRAM_MANAGER, CUSTOMER
routableAccountNumber	eq, in

---

Sorting Fields

You can sort data using the following fields:

Field	Description
id	Sort by account ID
createdOn	Sort by creation date
lastUpdatedOn	Sort by last update date

---

Example Request

List All Active Accounts

POST /banking/us2/v1/account/list HTTP/1.1
Host: api.ahrvo.network
Authorization: Bearer {placeholder("JWT token")}
x-api-key: {placeholder("your-api-key")}
Content-Type: application/json

{
    "sortOptions": {
        "sortBy": "createdOn",
        "sortOrder": "DESC"
    },
    "criteria": {
        "filters": [
            {
                "operator": "eq",
                "key": "status",
                "values": [
                    "ACTIVE"
                ]
            }
        ]
    }
}

---

Example Response

{
    "totalCount": 2331,
    "returnedCount": 1,
    "pageNumber": 1,
    "offset": 4008907,
    "hasMore": "true",
    "resources": [
        {
            "resourceName": "account",
            "url": "/v1/customer/id/4213479/account/id/4009308",
            "id": 4009308,
            "externalId": "New_Acc_Virtual_Card",
            "accountNumber": "8125000200005621",
            "status": "ACTIVE",
            "statusReason": "ACTIVATED_BY_SYSTEM",
            "statusDate": "09/14/2023 06:09:46",
            "balance": {
                "amount": "0.00",
                "asOn": "09/14/2023 11:20:04"
            },
            "purpose": "CHECKING",
            "routableAccount": {
                "accountNumber": "76650000004347",
                "routingNumber": "053101561",
                "wireRoutingNumber": "122287251",
                "wireAccountNumber": "13976650000004347",
                "wireMemo": " Alex Johnson 13976650000004347",
                "memo": " Alex Johnson 76650000004347"
            },
            "createdOn": "09/14/2023 06:09:46",
            "createdBy": {
                "username": "DEFAULT_USER",
                "status": "ACTIVE",
                "userType": "INTERNAL"
            },
            "lastUpdatedBy": {
                "username": "DEFAULT_USER",
                "status": "ACTIVE",
                "userType": "INTERNAL"
            },
            "lastUpdatedOn": "09/14/2023 06:09:46",
            "isCustomerOwned": false,
            "nickName": "New_Acc_Virtual_Card",
            "activationDate": "09/14/2023 06:09:46",
            "isPrimary": true
        }
    ]
}

---

Response Fields

Field	Type	Description
totalCount	integer	Total number of matching accounts
returnedCount	integer	Number of accounts returned in this page
pageNumber	integer	Current page number
offset	integer	Offset for pagination
hasMore	string	Whether more results are available
resources	array	Array of account objects

Response Status

HTTP Status: 200 OK

---

Important Notes

Data Latency

The Account List API returns data with a latency of 30 minutes. Recently created or updated accounts may not appear immediately in results.

Pagination

Use the offset and pageNumber fields to paginate through large result sets. The hasMore field indicates whether additional pages are available.

Filter Operators

• eq — equals
• ne — not equals
• in — in a list of values
• gt / gte — greater than / greater than or equal
• lt / lte — less than / less than or equal

---

Interactive API Explorer