BPN
  1. Account Management
BPN
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
  • API Reference
    • KYB
      • Share KYB Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • add bank account
        POST
      • list bank account
        GET
      • create virtaul account
        POST
      • list virtual account
        GET
      • Master VA balance inquiry
        GET
      • list virtual account orders
        GET
      • refund virtual account order
        POST
    • Wallet
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • fx inquery
    • BPN Transactions
      • get stablecoin quote
      • create stable order
      • get order (single) detail
      • list orders(batch)
    • Reconciliation
  • Webhooks & Event
    • resend fail webhook
      POST
    • KYB Status Notification
      POST
    • Transaction Status Notification
      POST
    • Account Status Notification
      POST
    • Open Virtual Account Status
      POST
    • Deposit Sender Detail Required
      POST
    • virtual account payment status
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List
  • Release Notes & Changelog
    • Version History
  • Schemas
    • Schemas
      • walletBalance
      • walletAddress
      • transactionRecord
  1. Account Management

list virtual account

GET
/v1/virtual-account/sub/list
Purpose:
To retrieve a list of virtual accounts created under a business or its sub-users, with support for filtering by account details, currency, creation date, and pagination.
What this endpoint does:
Returns detailed information about virtual accounts, including account numbers, bank details, status, and associated user/sub-user IDs. This endpoint is useful for operational tracking, reconciliation, customer service support, and back-office reporting.
Keynotes:
Supports multiple filters such as accountId, subUserId, currency, and creation time range (startTimestamp, endTimestamp).
Pagination parameters pageNum and pageSize help manage large result sets.
Returned account details may vary depending on currency and jurisdiction — e.g., IBAN and SWIFT codes may not be applicable in all cases.
Account status values typically include:
INIT： Account creation initiated but not yet active
SUCCESS： Account successfully created and active
FAIL： Account creation failed
Useful for listing all virtual accounts associated with a business for audit, support, or transaction routing purposes.
traceId is always returned for troubleshooting and request correlation.

Request

Query Params

Responses

🟢200OK
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v1/virtual-account/sub/list?accountId=&accountName=&currency=&startTime=&endTime=&pageNum=0&pageSize=0'
Response Response Example
{
    "status": 0,
    "message": "string",
    "data": {
        "pageNumber": 0,
        "pageSize": 0,
        "totalPage": 0,
        "totalRow": 0,
        "records": [
            {
                "virtualAccountId": "string",
                "accountName": "string",
                "currency": "string",
                "status": "string",
                "qrCode": "string",
                "qrCodeImage": "string",
                "subAccountType": "string",
                "expireTime": "string"
            }
        ]
    },
    "traceId": "string"
}
Modified at 2025-09-10 13:21:21
Previous
create virtaul account
Next
Master VA balance inquiry
Built with