# Event Notification

## Usage

* This is the API that the Platform should create to receive notifications of events that occur from NeoX. 
* Sequence Diagram

  * Notifies about balance amount

  <figure><img src="/files/Kuo2yxWPSS5ksDW6xQWw" alt=""><figcaption></figcaption></figure>

  * Notifies about disbursement transaction

  <figure><img src="/files/nhBF7mBEU0esPAU5cDU5" alt=""><figcaption></figcaption></figure>

## API

* Path: the URL(*https\://<\<yourdomain.com/api/notifi>>*) Webhook is created and configured by Platform on Merchant Portal, in the “Disbursement service” menu&#x20;
* Method: POST&#x20;
* Request: Body&#x20;

## Notification type

### **Notifies about balance amount**

<table><thead><tr><th width="144.33333333333334">Parameter</th><th width="126">Data Type </th><th>Description</th></tr></thead><tbody><tr><td>service </td><td>String </td><td>“<em>DISBURSEMENT</em>” </td></tr><tr><td>type </td><td>String </td><td>“<em>BALANCE</em>” </td></tr><tr><td>value </td><td>Number </td><td>The current amount. </td></tr><tr><td>time </td><td>String </td><td>The time of the event. </td></tr><tr><td>secureHash </td><td><p>String </p><p>(Base64) </p></td><td>Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu) </td></tr></tbody></table>

### **Notifies about disbursement transaction happened**

<table><thead><tr><th width="144">Parameter</th><th width="108.33333333333334">Data Type </th><th>Description</th></tr></thead><tbody><tr><td>service </td><td>String </td><td>“<em>DISBURSEMENT</em>” </td></tr><tr><td>type </td><td>String </td><td>“<em>TRANSACTION</em>” </td></tr><tr><td>data </td><td>Object </td><td>Data response, refer to  <a href="/pages/FvYjr9HJVHxqeU1fDsHI">DisbursementTransactionItem</a> </td></tr><tr><td>time </td><td>String </td><td>The time of the event. </td></tr><tr><td>secureHash </td><td><p>String </p><p>(Base64) </p></td><td>Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu) </td></tr></tbody></table>

### **Notifies about currency exchanged**

<table><thead><tr><th width="144">Parameter</th><th width="108.33333333333334">Data Type </th><th>Description</th></tr></thead><tbody><tr><td>service </td><td>String </td><td>“<em>DISBURSEMENT</em>” </td></tr><tr><td>type </td><td>String </td><td>“<em>EXCHANGE</em>” </td></tr><tr><td>data </td><td>Object </td><td>Data response, refer to  <a href="/pages/FvYjr9HJVHxqeU1fDsHI#exchangetransactionitem">ExchangeTransactionItem</a></td></tr><tr><td>time </td><td>String </td><td>The time of the event. </td></tr><tr><td>secureHash </td><td><p>String </p><p>(Base64) </p></td><td>Use SHA256 to hash the above parameters (sort the key by Alphabet order) + Secret Key (configured on Merchant Portal, in the “Disbursement service” menu) </td></tr></tbody></table>


---

# Agent Instructions: 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:

```
GET https://docs.neox.vn/docs/global/disbursement/integration/event-notification.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.