Skip to main content

Refund Asynchronous Notification


The server returns after receiving the refund notification from the payment provider.
If no notification receiving address is provided when applying for a refund, no notification request will be initiated.

Info

notify_url needs to be provided when requesting a refund.

NameTypeDescriptionRequirement
notify_typeString(30)Notification type
Fixed: trade_status_sync
trade_typeString(10)Transaction type
REFUND
user_confirm_keyStringUser Key provided by eftPay
transaction_idString(64)Payment provider order number
trade_noString(64)Payment provider order number
out_trade_noString(28)Merchant order number
total_feeString(8)Order total amount
currencyString(5)Currency type
trade_statusString(32)Transaction status, see Appendix 2
gmt_paymentStringTransaction time, format: yyyy-MM-dd HH:mm:ss
walletString(20)Wallet type
tidString(20)Merchant terminal number
eft_trade_noString(28)eftPay order number
eftpay_trade_noString(28)eftPay order number
return_amountString(8)Refund amount
refund_noString(28)Refund number
rejectReasonString(28)Octopus refund failure reason, only returned by Octopus
timeStringTime, format: yyyyMMddHHmmss
signString(64)Signature

The following parameters must be returned upon receiving the transaction notification.

NameTypeDescriptionRequirement
return_codeString(10)Return code
success/false
timeStringTime, format: yyyyMMddHHmmss
signString(64)Signature

{
    "currency": "HKD",
    "eft_trade_no": "18520003650610023041t5ruq5va732",
    "eftpay_trade_no": "18520003650610023041t5ruq5va732",
    "gmt_payment": "2020-01-20 10:35:34",
    "notify_type": "trade_status_sync",
    "out_trade_no": "20200120103448",
    "refund_no": "R_20200120103526_0",
    "return_amount": "0.02",
    "time": "20200120110948",
    "total_fee": "0.02",
    "trade_no": "4200000994202001206533192063",
    "trade_status": "TRADE_CLOSED",
    "trade_type": "REFUND",
    "transaction_id": "4200000994202001206533192063",
    "user_confirm_key": "61002304",
    "wallet": "WECHATCN",
    "sign": "13a0a514971ded891920554346b5c83362f58dd7580554f3ef66f9859fbfe916"
}

{
    "time": "20230609110646",
    "sign": "2c418bfb1085b0cabbf2f5c6de71db0694a5a78b7271b05ca6d5a8b70227ebb2",
    "return_code": "success"
}