> For the complete documentation index, see [llms.txt](https://docs.neox.vn/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neox.vn/docs/global/global-collections/virtual-account-management/webhook.md).

# Webhook

For webhook delivery mechanics, security verification, and retry behaviour, see [Event Notification](/docs/global/global-collections/integration/event-notification.md).

### 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

```json
{
  "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=="
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.neox.vn/docs/global/global-collections/virtual-account-management/webhook.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.