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
  • Sequence Diagram
  • Event data
  • Sample data

Was this helpful?

  1. Collections
  2. Virtual Account Management

Webhook

PreviousVirtual Account StatusNextTransaction Management

Last updated 2 months ago

Was this helpful?

Sequence Diagram

Event data

Parameter
Data Type
Description

requestId

String

The ID of the request.

type

String

“ACCOUNT”

merchantId

String

The ID of merchant.

virtualAccounts

Array

The array contains the list of created virtual accounts.

createdAt

String

The time of creating account.

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)

VirtualAccount

Parameter
Data Type
Description

accountName

String

The ID of seller/business is provided by merchant.

receiver

String

The name of receiver.

bankId

String

The Swift Code of the bank.

bankName

String

Bank name

serviceInfomation

Object

bankAccountNumber

String

The bank account number.

qrText

String

QR Code

virtualAccountRequestId

String

The ID of seller/business is provided by merchant

transferNote

String

Transfer Contents

code

Number

status

String

Status of virtual account creation: SUCCESS FAILED PROCESSING

Service Information

Parameter
Data Type
Required
Description

code

String (up to 10 latin chars)

N

Service code which is defined by the merchants. This code will be used to filter the VAs and grouped Reconciliations on Merchant Portal

groupId

String (up to 10 latin chars)

N

Id of VA group which is defined by the merchants. This id will be used to filter the VAs on Merchant Portal

desc

String (up to 256 latin chars)

N

Description of VA

Sample data

{
  "requestId": "63ea2832-8448-4993-8bff-9748cd3aed64",
  "merchantId": "62aa8e8311c8360019132856",
  "type": "ACCOUNT",
  "createdAt": "2023-11-15T02:27:18.241Z",
  "virtualAccounts": [
    {
      "virtualAccountRequestId": "5029e5b0-5824-4a0c-bd7a-808439cced22",
      "bankAccountNumber": "NEO0003044",
      "bankId": "MSCBVNVX",
      "bankName": "Military Commercial Joint stock Bank",
      "transferNote": "NEO1700015238057",
      "receiver": "ACC SBX 001",
      "accountName": "ACC SBX 001",
      "qrText": "00020101021238540010A000000727012400069704220110NEO00030440208QRIBFTTA53037045802VN5911ACC SBX 00162200816NEO17000152380576304FA4E",
      "serviceInformation": {
        "code": "code1",
        "desc": " test",
        "groupId": "group1"
      },
      "code": 1,
      "status": "SUCCESS"
    }
  ],
  "secureHash": "vpE2KAJ78GTrIXUkdxp8m3WOeR8rBRPAeth1/mP3sWE="
}

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

2023-11-15T02:27:18.241Z62aa8e8311c836001913285663ea2832-8448-4993-8bff-9748cd3aed64ACCOUNTACC SBX 001NEO0003044MSCBVNVXMilitary Commercial Joint stock Bank100020101021238540010A000000727012400069704220110NEO00030440208QRIBFTTA53037045802VN5911ACC SBX 00162200816NEO17000152380576304FA4EACC SBX 001code1 testgroup1SUCCESSNEO17000152380575029e5b0-5824-4a0c-bd7a-808439cced22123

Refer to below

Refer to

Refer to

Error Codes
VirtualAccount
Service Information
Configure the webhook