API Documentation
NeoX documents
NeoX documents
  • Introduction
  • NeoX App
    • E-Wallet
    • eKYC
    • Functionality
  • Payment Gateway
    • Payment Methods
    • Integrations
      • Hosted Checkout
        • Plugin/Extenstion
        • iOS SDK
        • Android SDK
        • React Native SDK
        • Web SDK
        • APIs
      • Direct API
        • Tokenization
      • Refund
        • APIs
        • IPN
    • Transaction Management
      • Query DR
      • Cancel
      • IPN
      • Error Codes
      • Refund on portal
    • Reconciliation
    • Settlement
  • Disbursement
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • Generate token API
      • Get merchant profile API
      • Request disbursement API
      • Get disbursement transaction API
      • Get exchange rate API
      • Inquiry bank account API
      • Currency conversion API
      • Event Notification
      • Response Data Structure
      • Error codes
    • Disbursement Account
    • Disbursement request
    • Transaction Management
      • Query Request/Transaction
      • Webhook
      • Error Codes
    • Reconciliation
  • Collections
    • Integration
      • Introduction
      • How To Register
      • Security Method
      • API authenPlatform
      • API upload file
      • APIs for virtual accounts management
        • API create list of virtual accounts
        • API update KYC virtual account information
        • API update Virtual Account transaction data from merchant
        • API set active/inactive Virtual Account
        • API get list virtual accounts
        • API get detail virtual account
      • APIs for transactions management
        • API update transaction documents
        • API get list transactions
        • API get detail transaction
      • APIs for refund requests management
        • API create refund request
        • API get list refund requests
        • API get detail refund request
      • APIs for withdraw requests management
        • API get list withdraw banks
        • API create withdraw request
        • API get list withdraw requests
        • API get detail withdraw request
      • Event Notification
      • SFTP upload document file of collection transaction
      • Error Codes
    • Virtual Account Management
      • Virtual Account
      • Virtual Account Status
      • Webhook
    • Transaction Management
      • Webhook
    • Transaction Status Management
      • Webhook
    • Refund Request Management
      • Webhook
    • Withdraw Request Management
      • Webhook
    • Reconciliation
    • Settlement
  • Merchant Portal
    • Onboarding
    • Payment Gateway
      • Reconciliation
      • Withdraw
    • Disbursement
      • Reports
    • Collections
      • Reports
      • Withdraw
Powered by GitBook
On this page

Was this helpful?

  1. Collections
  2. Virtual Account Management

Virtual Account Status

PreviousVirtual AccountNextWebhook

Last updated 23 days ago

Was this helpful?

Sequence Diagram

Event data

Parameter
Data Type
Description

type

String

ACCOUNT_STATUS

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.

accountAddress

String

Virtual Account address.

bankId

String

The bank swiftcode of virtual account.

bankName

String

The bank name of virtual account.

qrText

String

Napas QR Code plain data for 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: UNAUTHORIZED: KYC/KYB documents for VA were not uploaded. PENDING: KYC/KYB documents for VA were uploaded, waiting to verify. AUTHORIZED: KYC/KYB documents for VA have been approved. REJECT: KYC/KYB documents for VA have been rejected.

serviceInfomation

Object

note

String

Note for current virtual account.

createdAt

Datetime String (ISO 8601)

Record created time

updatedAt

Datetime String (ISO 8601)

Record last updated time

secureHash

String

(Base64)

Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the Collection service menu)

### Sample data

{
  "type": "ACCOUNT_STATUS",
  "merchantCode": "MSFEAF",
  "requestId": "d7fd1438-1c30-46c9-8ba1-bceeafc5198a",
  "virtualAccountRequestId": "4c3ad2bd-a910-4c9b-96ca-77fd46e69239",
  "bankAccountNumber": "M9629245",
  "accountName": "YHTEACR1",
  "accountAddress": "48172 Myrtis Views",
  "bankId": "VTCBVNVX",
  "bankName": "Vietnam Technological and Commercial Joint stock Bank",
  "qrText": "00020101021238520010A000000727012200069704070108M96292450208QRIBFTTA53037045802VN62090805NEO4563040CA8",
  "status": "ACTIVE",
  "authorizeStatus": "UNAUTHORIZED",
  "serviceInformation": {
    "id": "4953df2a-0477-44ac-b615-88aea5eb9070",
    "code": "AMD",
    "desc": "portals",
    "groupId": "Garden"
  },
  "note": "",
  "createdAt": "2025-04-23T14:43:06.883Z",
  "updatedAt": "2025-04-23T14:55:58.497Z",
  "secureHash": "1l5kbr2tzqsAwPTq+0Ol8y4TRNReld8gamrp2KPevQc="
}

With the secretKey "SOME_secret_123", the string used to create secureHash will be:

48172 Myrtis ViewsYHTEACR1UNAUTHORIZEDM9629245VTCBVNVXVietnam Technological and Commercial Joint stock Bank2025-04-23T14:43:06.883ZMSFEAF00020101021238520010A000000727012200069704070108M96292450208QRIBFTTA53037045802VN62090805NEO4563040CA8d7fd1438-1c30-46c9-8ba1-bceeafc5198aAMDportalsGarden4953df2a-0477-44ac-b615-88aea5eb9070ACTIVEACCOUNT_STATUS2025-04-23T14:55:58.497Z4c3ad2bd-a910-4c9b-96ca-77fd46e69239SOME_secret_123

Refer to

Configure the webhook
ServiceInformationData.