> 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/payout-request-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 Payout Request. Use this to correlate the webhook with your application record. | | type | string | Event type. Fixed value: `"PAYOUT"`. | | merchantCode | string | NeoX merchant code of the account owner. | | serialNum | string | Platform serial number assigned to this payout transaction. | | amount | number | Payout amount in the sending currency (`currency`). | | currency | string | ISO 4217 currency code of the payout (sending side). | | creditedAmount | number | Amount credited to the beneficiary after conversion and fees. | | creditedCurrency | string | ISO 4217 currency code of the credited (receiving) amount. | | fxRate | number | FX rate applied to this payout, if a currency conversion occurred. | | feeAmount | number | Total fee charged for this payout in `feeCurrency`. | | feeCurrency | string | ISO 4217 currency code in which the fee is denominated. | | status | string | Terminal payout status. Enum: `SUCCESS` \| `FAIL`. See Status Values below. | | createDt | date string | Timestamp when the payout request was created (ISO 8601). | | completeDt | date string | Timestamp when the payout reached its terminal status (ISO 8601). | | msg | string | Human-readable result message or failure reason. | | code | string | Result or error code accompanying the `status`. | | 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. | #### Status Values | Status | Meaning | | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SUCCESS` | The payout has been successfully completed and the beneficiary has been credited. | | `FAIL` | The payout failed. Check the `msg` and `code` fields for the failure reason, and use the Get Detail Payout Request API to retrieve the `errorFilePath` for a detailed error report. | This webhook covers both the overall payout completion result (the aggregate outcome of the full payout request) and individual per-payee distribution results (the outcome for each beneficiary in a batch payout). Both event types carry the same payload structure, distinguished by the `requestId` value — the parent request ID for the aggregate event, and the individual distribution request ID for per-payee events. ### Sample data ```json { "requestId": "b2c3d4e5-2222-3333-4444-bbccddeeff00", "type": "PAYOUT", "merchantCode": "MC-00012345", "serialNum": "SN2024081500112233", "amount": 5000.00, "currency": "USD", "creditedAmount": 36407.50, "creditedCurrency": "CNH", "fxRate": 7.2815, "feeAmount": 15.00, "feeCurrency": "USD", "status": "SUCCESS", "createDt": "2024-08-15T09:00:00Z", "completeDt": "2024-08-15T09:45:00Z", "msg": "Payout completed successfully", "code": "0", "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/payout-request-management/webhook.md?ask=&goal= ``` `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.