Skip to main content
GET
/
accounts
/
virtual-accounts
/
{id}
Retrieve Virtual Account
curl --request GET \
  --url https://api.usepooler.com/accounts/virtual-accounts/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "stan": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "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 detailed information about a specific virtual account by its ID.

Overview

This endpoint returns comprehensive details about a single virtual account, including account information, balance, status, and metadata.

Path Parameters

id
string
required
Virtual account UUID

Response

data
object
Complete virtual account object including:
  • 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
  • client_type: Account type (individual/business)
  • metadata: Additional metadata object
  • display_name: Display name
  • account_status: Account status
  • expiry_date: Account expiry date
  • 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}

Path Parameters

id
string<uuid>
required

Virtual account ID

Response

200 - application/json

Virtual account retrieved successfully

success
boolean
message
string
stan
string<uuid>
data
object