Refund

Transaction refund.

TRADE_PROCESSING(Processing transaction)
↓
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 failure)

Info

{domain}/Servlet/JSAPIService.do

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

Name	Type	Description
service	String	Interface name, see supported service
user_confirm_key	String(12)	User Key, provided by eftPay
return_amount	String(8)	Refund amount. Requires numbers, the maximum length of decimal places is 2
total_fee	String(8)	Total transaction amount. Requires numbers, the maximum length of decimal places is 2
out_trade_no	String(28)	Original consumer merchant order number
payType	String(6)	Payment type, see supported payType
buyerType	String(7)	Device type `ios`，`android`，`others`
reason	String(256)	Refund reason
wallet	String(20)	Wallet type, consistent with the original consumption transaction, see supported wallet
out_refund_no	String(28)	Merchant refund number
eft_trade_no	String(28)	eftPay order number
pay_scene	String	Payment scene
notify_url	String(240)	Notification address, the 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
time	String	Time, format: `yyyyMMddHHmmss`
sign	String(64)	Signature

View supported services along with their payType and wallet

Here is the correspondence between service, payType, and wallet

service	payType	wallet	Description
service.alipay.web.Refund	`Alipay`	`ALIPAYCN` `ALIPAYHK`	Alipay web refund interface
service.wechat.web.Refund	`WeChat`	`WECHATCN` `WECHATHK`	WeChat web refund interface
service.wechat.web.ApplyRefund	`WeChat`	`WECHATCN` `WECHATHK`	WeChat web apply refund interface
service.icbc.wap.Refund	`ICBC`	`ICBCWAP`	ICBC wap refund interface
service.atome.v2.wap.Refund	`ATOME`	`ATOME`	ATOME online refund interface
service.unionpay.online.web.Refund	`UnionPay`	`UNIONPAY`	UnionPay online cash register refund interface
service.oct.online.Refund	`OCT`	`OCT`	Octopus online apply refund interface
service.fdms.web.Refund	`Fdms`	`FDMS`	FDMS VISA, Master refund interface
service.mpgs.web.Refund	`Mpgs`	`MPGS`	MPGS VISA, Master refund interface
service.ae.web.Refund	`AE`	`AE`	AE refund interface
service.nuvei.web.Refund	`NUVEI`	`NUVEI`	NUVEI VISA, Master refund interface
service.jetco.wap.Refund	`Jetco`	`JETCOHK`	Jetco wap refund interface
service.payme.web.Refund	`PAYME`	`PAYME`	PayMe web refund interface
service.bocvmp.unionpay.web.Refund	`BOCVMP`	`BOCVMPUPW`	BOC web refund interface

Tips

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

Name	Type	Description
return_status	String(3)	Return status code, represents . Note: This parameter cannot be used to judge whether the transaction status is successful Other status codes see Appendix 3
return_char	String(100)	Return description, may change, cannot be used as a condition judgment
Return when return_status is greater than 00
time	String	Time, format: `yyyyMMddHHmmss` `return_status` >= `00` when returned
sign	String(64)	Signature `return_status` >= `00` when returned

Name	Type	Description
out_trade_no	String(28)	Original consumer merchant order number
out_refund_no	String(28)	Merchant refund number
eft_trade_no	String(28)	eftPay order number
trade_status	String(32)	Trade status, see Appendix 2
refund_time	String	Refund transaction time, format: `yyyyMMddHHmmss`
user_confirm_key	String	User Key, provided by eftPay
payType	String(6)	Payment type
buyerType	String(7)	Device type
wallet	String(20)	Wallet type
fee_type	String(5)	Currency
return_amount	String(8)	Refund amount
total_fee	String(8)	Original transaction amount
tid	String(20)	Terminal number, returned when there is a consumption request

{
	"service": "service.alipay.web.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": "580e4a26db5e601e3a1b89b3fc815b5c2122a4ccc18fa90742c8641c172e8c77"
}

{
    "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"
}

Refund

#

#

#

#

#

#

#