API get list virtual accounts

  • Purpose: This is the API used to get list virtual accounts.

  • API:

    • Path: v2/col/virtual-accounts

    • Method: GET

    • Request: Content-Type: application/json

Request Parameter

Parameter
Data Type
Required
Description

pageIndex

Number

N

Pagination index (start from 1, default value is 1)

pageSize

Number

N

Current Page size (Default value is 20, maximum value is 500)

dateFr

Datetime String (ISO 8601)

N

Get records created from date

dateTo

Datetime String (ISO 8601)

N

Get records created to date

status

String

N

To filter virtual account list by status

authorizeStatus

String

N

To filter virtual account list by authorize status

requestId

String

N

To filter virtual account list by requestId when create VA

Response Data

Parameter
Data Type
Description

code

Number

Error code, refer to table of error codes.

data

Object

Return Object as follow:


{
  "totalDocs": Number, // Total records base on request params
  "totalPages": Number, // Total pages base on request pageSize
  "docs": Array of GetListVirtualAccountsResponse
}

Ref to GetListVirtualAccountsResponse object.

message

String

Error description

neoResponseId

String

The ID of NeoX response

GetListVirtualAccountsResponse

Parameter
Data Type
Description

merchantCode

String

Merchant Code

requestId

String

The requestId when creating virtual account.

virtualAccountRequestId

String

The ID of seller/business is provided by merchant.

bankAccountNumber

String

Virtual Account number.

accountName

String

Virtual Account name.

bankId

String

The bank swiftcode of virtual account.

status

String

Virtual account active status, include: ACTIVE: Virtual account has been actived and can be used. INACTIVE: Virtual account has been inactived and can not be used.

authorizeStatus

String

Virtual account authorize status, Include: PENDING_KYC: KYC/KYB documents for VA were not uploaded. VERIFYING: KYC/KYB documents for VA were uploaded, waiting to verify. APPROVED: KYC/KYB documents for VA have been approved. REJECT: KYC/KYB documents for VA have been rejected

createdAt

Datetime String (ISO 8601)

Record created time

updatedAt

Datetime String (ISO 8601)

Record last updated time

Last updated

Was this helpful?