Webhook

For general webhook delivery mechanics, retry schedules, and how to configure your notifyUrl, see Event Notification.

Event data

Field Name	Type	Description
refundRequestId	string	Unique NeoX identifier for the refund request.
type	string	Event type. Fixed value: REFUND.
merchantCode	string	NeoX merchant code associated with the originating account.
collectionOrderId	string	The NeoX collection order ID that was refunded.
amount	number	Refund amount in the original transaction currency.
currency	string	ISO 4217 currency code of the refund (e.g. USD, EUR, HKD).
status	string	Current status of the refund. Enum: PROCESSING | SUCCESS | FAILED. See Status Values table below.
note	string	Additional details or reason message provided with the refund status update, if any.
createdAt	string	Timestamp when the refund request was created, in ISO 8601 format (e.g. 2024-05-01T10:30:00Z).
secureHash	string	Base64-encoded SHA-256 HMAC of the sorted payload fields concatenated with the merchant Secret Key. Used to verify webhook authenticity.

Status Values

Status	Description
PROCESSING	The refund has been accepted and is being processed by the payment network. Final status pending.
SUCCESS	The refund has been completed successfully and funds have been returned to the original payer.
FAILED	The refund could not be completed. Refer to the note field for the failure reason.

Sample data

{
  "refundRequestId": "RF-20240501-000987654",
  "type": "REFUND",
  "merchantCode": "MERCH-00012345",
  "collectionOrderId": "CO-20240501-000123456",
  "amount": 1500.00,
  "currency": "USD",
  "status": "SUCCESS",
  "note": "",
  "createdAt": "2024-05-01T10:30:00Z",
  "secureHash": "dGhpcyBpcyBhIHNhbXBsZSBiYXNlNjQtZW5jb2RlZCBoYXNo"
}