Skip to main content
GET
/
accounts
/
virtual-accounts
List Virtual Accounts
curl --request GET \
  --url https://api.usepooler.com/accounts/virtual-accounts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "total_pages": 123,
    "current_page": 123,
    "total_records": 123,
    "next_page": "<string>",
    "previous_page": "<string>",
    "items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "currency": "<string>",
        "account_number": "<string>",
        "account_name": "<string>",
        "bank_name": "<string>",
        "is_active": true,
        "created_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}
Retrieve a paginated list of all virtual accounts associated with your account.

​
Overview

This endpoint returns all virtual accounts you’ve created, allowing you to view their status, account numbers, and balances.

​
Query Parameters

​
page
integer
Page number for pagination (default: 1)
​
per_page
integer
Number of items per page (default: 10)

​
Response

​
data
object
Paginated response containing:
  • total_pages: Total number of pages
  • current_page: Current page number
  • total_records: Total number of virtual accounts
  • next_page: URL for next page
  • previous_page: URL for previous page
  • items: Array of virtual account objects
​
data.items[]
object
Each virtual account object includes:
  • id: Virtual account UUID
  • account_no: Account number
  • account_name: Account holder name
  • bank_name: Bank name
  • currency_code: Currency code
  • active: Whether account is active
  • amount: Current balance
  • first_name: First name
  • last_name: Last name
  • email: Email address
  • mobile_number: Phone number
  • bvn: Bank Verification Number
  • metadata: Additional metadata
  • created_at: Creation timestamp
  • updated_at: Last update timestamp

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Include your API key in the Authorization header as: Bearer {your_api_key}

Query Parameters

​
page
integer
default:1

Page number for pagination

​
per_page
integer
default:10

Number of items per page

Response

200 - application/json

Virtual accounts retrieved successfully

​
success
boolean
​
message
string
​
stan
string<uuid>
​
data
object