Fetch all virtual accounts
Learn how to fetch all virtual accounts
This endpoint is used to fetch all created virtual account for a merchant. Note that this endpoint return a paginated data which helps to control the size of data received.
To request for all created account, make a GET
request to the endpoint /v1/static-accounts
.
Pagination Query Parameters
The pagination approach used here follows page-based pagination, where pageNumber
and pageSize
control data retrieval. The response includes metadata like currentPage
, totalPages
, totalCount
, and flags hasPrevious
, hasNext
to indicate available pages.
pageNumber
The page number to retrieve. Defaults to 1 if not provided.
pagesize
The number of records per page. Defaults to 10 if not specified.
startData
Filter dataset by account creation date
endDate
: Filter dateset by expiryDate
These parameters allow clients to control paginated data retrieval efficiently.
fetch all created virtual account request
Create virtual account response
An example response body for successfully fetching virtual accounts.
When virtual accounts are successfully fetched, the response contains a data object that includes a list of accounts, with each containing details such as accountNumber
, bankName
, and isActive
status.
Handling fetch virtual account response
Indicates if the request was successful.
Descriptive message about the request result.