Webhook
For webhook delivery mechanics, security verification, and retry behaviour, see Event Notification.
This page documents 2 event types covering the refund lifecycle of a trade/platform collection order: TRADE_COLLECTION_REFUND_PROCESS and TRADE_COLLECTION_REFUND_SUCCESS.
Create Refund Request accepts a webhookUrl field, but it is not used to deliver refund status notifications. Both events below are delivered through the collection-transaction event group instead, using the URL and secret pre-configured centrally for your merchant account (see Event Notification). This is a deliberate design decision, not an oversight: refunds are tracked as part of the originating collection order's lifecycle rather than as a standalone stream.
TRADE_COLLECTION_REFUND_PROCESS
Sent when a refund against a trade/platform collection order starts processing.
Event data
type
string
Event type. Fixed value: TRADE_COLLECTION_REFUND_PROCESS.
subMerchantId
string
NeoX identifier of the sub-merchant that owns the receiving virtual account, if applicable.
orderId
string
NeoX identifier of the original collection order being refunded.
requestId
string
Unique identifier for this webhook event. Use this for idempotency.
refundRequestId
string
The requestId of the originating Create Refund Request.
refundAmount
number
Amount being refunded.
refundCurrency
string
Currency of refundAmount.
feeAmount
number
Fee charged for the refund, if any.
feeCurrency
string
Currency of feeAmount.
beneAccountNum
string
Account number the refund is being returned to.
beneAccountName
string
Account name the refund is being returned to.
status
string
Fixed value: PROCESS.
createdAt
string
Timestamp when the refund was created (ISO 8601).
extData
string
Reserved for future use. Currently always the literal string "{}".
Sample data
TRADE_COLLECTION_REFUND_SUCCESS
Sent when a refund against a trade/platform collection order completes successfully. Same fields as TRADE_COLLECTION_REFUND_PROCESS, with status=SUCCESS and an additional completedAt field.
Event data
Same fields as TRADE_COLLECTION_REFUND_PROCESS above, except:
type
string
Event type. Fixed value: TRADE_COLLECTION_REFUND_SUCCESS.
status
string
Fixed value: SUCCESS.
completedAt
string
Timestamp when the refund completed (ISO 8601).
Sample data
Last updated
Was this helpful?