Get List Virtual Accounts

Endpoint: GET /v2/gc/virtual-accounts

Description: Retrieve a paginated list of virtual account applications with optional filters by date range, status, currency, or sub-merchant.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
pageIndex	number	No	Index of the page to retrieve (pagination). Starts at 1.
pageSize	number	No	Number of items per page (pagination).
dateFr	date string	No	Filter results created on or after this date (YYYY-MM-DD).
dateTo	date string	No	Filter results created on or before this date (YYYY-MM-DD).
status	string	No	Filter by application status. Enum: INIT, PROCESSING, SUCCESS.
currency	string	No	Filter by currency (ISO 4217 code, e.g. USD).
subMerchantId	string	No	Filter by NeoX sub-merchant identifier.
requestId	string	No	Filter by the merchant-supplied requestId of the original application.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
state	number	State of the response.
data.docs	array	List of virtual account application documents.
data.totalDocs	number	Total number of documents matching the filter.
data.totalPages	number	Total number of pages available.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

docs object item fields:

Field Name	Type	Description
virtualAccountRequestId	string	NeoX identifier for this virtual account application.
merchantCode	string	NeoX merchant code of the account owner.
vaNumber	string	Assigned virtual account number. Populated after the account is approved.
vaName	string	Assigned virtual account name. Populated after the account is approved.
currency	string	Currency or currencies associated with the virtual account.
status	string	Current application status. Enum: INIT, PROCESSING, SUCCESS.
vaRegCountry	string	Country of registration in ISO 3166-1 alpha-3 format.
createdAt	date string	Timestamp when the application was created (ISO 8601).
updatedAt	date string	Timestamp of the most recent status update (ISO 8601).

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "docs": [
      {
        "virtualAccountRequestId": "VA-20240301-00012345",
        "merchantCode": "MC-00012345",
        "vaNumber": "HK8801234567890",
        "vaName": "Acme Trading Limited",
        "currency": "USD,EUR,HKD",
        "status": "SUCCESS",
        "vaRegCountry": "HKG",
        "createdAt": "2024-03-01T08:00:00Z",
        "updatedAt": "2024-03-02T14:30:00Z"
      },
      {
        "virtualAccountRequestId": "VA-20240305-00012346",
        "merchantCode": "MC-00012345",
        "vaNumber": "",
        "vaName": "",
        "currency": "USD",
        "status": "PROCESSING",
        "vaRegCountry": "SGP",
        "createdAt": "2024-03-05T10:15:00Z",
        "updatedAt": "2024-03-05T10:15:00Z"
      }
    ],
    "totalDocs": 2,
    "totalPages": 1
  },
  "message": "Successful",
  "neoResponseId": "e8f9a0b1-2345-4c67-d890-123456789012"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/virtual-accounts?pageIndex=1&pageSize=20&status=SUCCESS&currency=USD" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en"

Notes

• Requires Bearer token in the Authorization header.

• The Accept-Language header can be used to specify the response language (Support: "vi", "en").

• All query parameters are optional. Omitting them returns all virtual account applications for the authenticated merchant.

• Use dateFr and dateTo together to narrow results to a specific date range.

• The currency filter matches any virtual account that includes the specified currency.