Skip to main content

Refund


Transaction refund.

TRADE_PROCESSING (Transaction processing)

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

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

Info

{domain}/Servlet/JSAPIService.do

https://vmp.eftpay.com.cn/VMP/Servlet/JSAPIService.do

NameTypeDescriptionRequirement
serviceStringInterface name, see supported service
user_confirm_keyString(12)User Key, provided by eftPay
return_amountString(8)Refund amount. Requires digits, maximum decimal length is 2
total_feeString(8)Total transaction amount. Requires digits, maximum decimal length is 2
out_trade_noString(28)Original consumption merchant order number
payTypeString(6)Payment type, see supported payType
buyerTypeString(7)Device type
iosandroidothers
reasonString(256)Refund reason
walletString(20)Wallet type, consistent with the original consumption transaction, see supported wallet
out_refund_noString(28)Merchant refund number
eft_trade_noString(28)eftPay order number
pay_sceneStringPayment scene
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, see supported service
timeStringTime, format: yyyyMMddHHmmss
signString(64)Signature

View supported services and their corresponding payType and wallet

Here is the correspondence between service, payType, and wallet

servicepayTypewalletDescription
service.alipay.wap.RefundAlipayALIPAYCN
ALIPAYHK
Alipay wap refund interface
service.wechat.web.RefundWeChatWECHATCN
WECHATHK
WeChat web refund interface
service.wechat.web.ApplyRefundWeChatWECHATCN
WECHATHK
WeChat web refund application interface
service.icbc.wap.RefundICBCICBCWAPICBC wap refund interface
service.atome.v2.wap.RefundATOMEATOMEATOME online refund interface
service.unionpay.online.web.RefundUnionPayUNIONPAYUnionPay online cash register refund interface
service.oct.online.RefundOCTOCTOctopus online refund application interface
service.fdms.web.RefundFdmsFDMSFDMS VISA, Master refund interface
service.mpgs.web.RefundMpgsMPGSMPGS VISA, Master refund interface
service.ae.web.RefundAEAEAE refund interface
service.jetco.wap.RefundJetcoJETCOHKJetco wap refund interface
service.payme.web.RefundPAYMEPAYMEPayMe web refund interface
service.bocvmp.upi.wap.RefundBOCVMPBOCVMPUPIBOCPay wap refund interface

Tips

  • The notify_url parameter only takes effect when using the following refund application interfaces:
    • service.wechat.web.ApplyRefund
    • service.oct.online.Refund

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

NameTypeDescriptionRequirement
out_trade_noString(28)Original merchant order number for consumption
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

{
	"service": "service.alipay.wap.Refund",
	"user_confim_key": "12345678",
	"return_amount": "0.01",
	"total_fee": "0.02",
	"out_trade_no": "20190823191819",
	"payType": "Alipay",
	"buyerType": "ios",
	"reason": "",
	"out_refund_no": "20190824094947",
	"pay_scene": "WEB",
	"eft_trade_no": "08520005269190823191801988",
	"wallet": "ALIPAYCN",
	"time": "20230609110646",
	"sign": "c756436538bbba0794d83720bec24471412f5620d079a0268b9fe10381feb8e3"
}

{
    "user_confirm_key": "12345678",
    "return_amount": "0.01",
    "wallet": "ALIPAYCN",
    "return_char": "",
    "out_refund_no": "20190823191819",
    "sign": "cd6a175f61ff941fcd8b8bb4467944e3eaa64bfe572e6b6361624890bcda3d82",
    "fee_type": "HKD",
    "eft_trade_no": "08520005269190823191801988",
    "out_trade_no": "20190823191819",
    "payType": "Alipay",
    "refund_time": "20190824094950",
    "trade_status": "TRADE_CLOSED",
    "total_fee": "0.02",
    "return_status": "00",
    "buyerType": "ios",
    "time": "20230609110646"
}