Webhook

For webhook delivery mechanics, security verification, and retry behaviour, see Event Notification.

Event data

Field Name	Type	Description
requestId	string	Echoes the requestId supplied in the original Create Virtual Account request. Use this to correlate the webhook with your application record.
type	string	Event type. Fixed value: "VIRTUAL_ACCOUNT".
merchantCode	string	NeoX merchant code of the account owner.
virtualAccounts	array	List of virtual account items updated by this event. See virtualAccounts object item fields below.
createdAt	string	Timestamp when the event was generated (ISO 8601, e.g. "2024-03-02T14:30:00Z").
secureHash	string	Base64-encoded SHA256 hash of all payload fields (excluding secureHash) sorted alphabetically by key and concatenated with the Secret Key configured on the Merchant Portal. Use this to verify the authenticity of the payload.

virtualAccounts object item fields:

Field Name	Type	Description
virtualAccountRequestId	string	NeoX identifier for the virtual account application. Matches the value returned by the Create Virtual Account API.
vaNumber	string	Assigned virtual account number. Populated when status is SUCCESS.
vaName	string	Assigned virtual account name. Populated when status is SUCCESS.
currency	string	Currency or currencies associated with the virtual account (comma-separated ISO 4217 codes).
vaRegCountry	string	Country of registration in ISO 3166-1 alpha-3 format.
openBankName	string	Name of the bank where the virtual account is held. Populated when status is SUCCESS.
openBankSwiftCode	string	SWIFT/BIC code of the bank where the virtual account is held. Populated when status is SUCCESS.
status	string	Final status of the virtual account. Enum: SUCCESS, FAILED, PROCESSING.

Status Values

Status	Meaning
SUCCESS	The virtual account has been opened. Bank details (vaNumber, openBankSwiftCode, etc.) are now populated.
FAILED	The application was rejected or could not be completed. No bank details are assigned.
PROCESSING	The application is still under review. A subsequent webhook will be sent when it concludes.

Sample data

{
  "requestId": "d4e5f6a7-8901-4b23-c456-789012345678",
  "type": "VIRTUAL_ACCOUNT",
  "merchantCode": "MC-00012345",
  "virtualAccounts": [
    {
      "virtualAccountRequestId": "VA-20240301-00012345",
      "vaNumber": "HK8801234567890",
      "vaName": "Acme Trading Limited",
      "currency": "USD,EUR,HKD",
      "vaRegCountry": "HKG",
      "openBankName": "HSBC Hong Kong",
      "openBankSwiftCode": "HSBCHKHH",
      "status": "SUCCESS"
    }
  ],
  "createdAt": "2024-03-02T14:30:00Z",
  "secureHash": "Base64EncodedSHA256HashValue=="
}