Webhook
For webhook delivery mechanics, security verification, and retry behaviour, see Event Notification.
Event data
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
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
Last updated
Was this helpful?