Skip to main content

Refund


Transaction refund.

Currently only supports WeChat and Alipay.

TRADE_PROCESSING (Transaction processing)

APPLY_SUCCESS (Application successful, only available when applying for a refund)

TRADE_REFUND (Partial refund) / TRADE_CLOSED (Full refund, refund transaction closed) / TRADE_FAIL (Transaction failed)

Info

Refund:

{domain}/Servlet/AppTradeRefund.do

Apply for a refund:

{domain}/Servlet/AppTradeApplyRefund.do

(This interface is only effective for WeChat transactions, and calling this interface for Alipay transactions is equivalent to calling the refund interface)

// Refund:
https://vmp.eftpay.com.cn/VMP/Servlet/AppTradeRefund.do

// Apply for a refund:
https://vmp.eftpay.com.cn/VMP/Servlet/AppTradeApplyRefund.do

NameTypeDescriptionRequirement
user_confirm_keyString(12)User Key, provided by eftPay
return_amountString(8)Refund amount. Requires digits, maximum decimal places is 2
eft_trade_noString(28)eftPay order number
eft_trade_no and out_trade_no choose one
out_trade_noString(28)Original consumer merchant order number
out_trade_no and eft_trade_no choose one
out_refund_noString(28)Merchant refund number
buyerTypeString(7)Device type
ios, android, others
reasonString(256)Refund reason
notify_urlString(240)Notification address, production environment only supports 80 and 443 ports, other ports need to apply. P.S. Effective when calling the refund application interface
timeStringTime, format: yyyyMMddHHmmss
signString(64)Signature

Tips

  • Priority eft_trade_no > out_trade_no

NameTypeDescriptionRequirement
return_statusString(3)Return status code, represents . Note: This parameter cannot be used to judge whether the transaction status is successful
For other status codes, see Appendix 3
return_charString(100)Return description, may change, cannot be used as a condition for judgment
Return when return_status is greater than 00
timeStringTime, format: yyyyMMddHHmmss
return_status >= 00 is returned
signString(64)Signature
return_status >= 00 is returned

NameTypeDescriptionRequirement
out_trade_noString(28)Original merchant order number
out_refund_noString(28)Merchant refund number
eft_trade_noString(28)eftPay order number
trade_statusString(32)Transaction status, see Appendix 2
refund_timeStringRefund transaction time, format: yyyyMMddHHmmss
user_confirm_keyStringUser Key, provided by eftPay
payTypeString(6)Payment type
buyerTypeString(7)Device type
walletString(20)Wallet type
fee_typeString(5)Currency
return_amountString(8)Refund amount
total_feeString(8)Original transaction amount
tidString(20)Terminal number, returned when the consumption request is sent
rateString(10)Transaction exchange rate, returned when configured

{
    "return_amount": "0.61",
    "reason": "退款原因",
    "buyerType": "android",
    "eft_trade_no": "20005269520084311t5rutcv1734",
    "user_confim_key": "S0003469",
    "out_trade_no": "rrn_1686280005979",
    "out_refund_no": "rrn_1686280005979R",
    "time": "20230609110645",
    "sign": "0f81b3875590a29b84fbbb2527bff48cd340f2bfb94589ab5c8dd4635629dbdc"
}

{
    "user_confirm_key": "S0003469",
    "return_amount": "0.22",
    "wallet": "ALIPAYCN",
    "return_char": "",
    "out_refund_no": "rrn_1686280005983R",
    "sign": "46735e26e0012fb5e1ca16cc9e365d19cb3a486250ebd29c3be4c7166fcd47c1",
    "fee_type": "HKD",
    "eft_trade_no": "20005269520084311t5rutcv1734",
    "out_trade_no": "rrn_1686280005983",
    "payType": "Alipay",
    "refund_time": "20230609110645",
    "trade_status": "TRADE_CLOSED",
    "total_fee": "0.22",
    "return_status": "00",
    "buyerType": "android",
    "time": "20230609110645"
}