一般消费户退款接口
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2019/4/20 |
新接口参数定义 |
邓文泉 |
V0.2 |
2021/01/21 |
修改ACQ_QUERY_NO_RECORD的描述 |
王晶 |
V0.3 |
2021/07/28 |
增加out_request_no、退款流水号refundsn响应 |
王晶 |
V0.4 |
2021/08/24 |
如果原交易业务代码为00510140协议支付分期,不支持一般消费户退款 |
王晶 |
V0.5 |
2021/12/27 |
支持国密 |
王晶 |
V0.6 |
2022/02/21 |
支持异步通知 |
刘雷 |
V0.7 |
2022/04/19 |
增加入参refund_mer_id ,支持指定出资商户号(支持发起方出资退款) |
王晶 |
2.业务说明
(1)场景说明
1、对于支付完成的交易,需要进退款操作的,调用此接口来进行退款
(2)接口说明
1、商户根据实情情况,调用一般消费户退款接口进行退款操作
3.请求地址
4.参数说明
4.1公共请求参数
参数 |
类型(长度) |
Y |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.trade.refund.general.account |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
version |
String(3) |
Y |
接口版本3.0 当前版本 3.0 |
tran_type |
String(1) |
N |
交易类型,说明:1或者空:即时到账,2:担保交易 |
notify_url |
String(500) |
N |
交易成功异步通知到商户的后台地址,http路径支持多个url进行异步通知,多个url用分隔符“,”分开,格式如:url1,url2,url3,支持TLS1.0、TLS1.1、TLS1.2 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
N |
商户原交易订单号, 示例值:201805256843192280647118 |
|
shopdate |
String(8,8) |
Y |
商户系统的交易发生日期格式yyyyMMdd 示例值:20180525 |
trade_no |
String(1,30) |
N |
银盛原交易流水号 示例值:311160414497667096 |
refund_amount |
Number(10,2) |
Y |
需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数,Number(10,2)指10位长度,2位精度 示例值:111.00 |
refund_reason |
String(1,50) |
Y |
退款的原因说明,该参数最长为50个汉字。 |
out_request_no |
String(1,32) |
Y |
商户系统生成的退款订单号,标识一次退款请求,同一笔交易多次退款需要保证唯一。该参数支持汉字,最大长度为16个。用同一订单号同一退款流水号继续退款时,则会返回第一次退款的结果不会继续退款 示例值:RD2012061713107 |
is_division |
String(2) |
N |
原交易是否参与分账(01或空代表是,02代表否) 示例值:02 |
refund_mer_id |
String(16) |
N |
默认为空,如果需要指定退款由发起方一般消费户出资,该字段填发起方商户号 |
refund_split_info |
Json数组 |
N |
退款分账明细,分账退款金额总和等于退款金额,当原交易参与分账时,该参数必传,原交易不参与分账或者全额退款,该参数可空 |
4.3 refund_split_info
refund_split_info |
Json数组 |
必填 |
参数说明 |
refund_mer_id |
String(20) |
N |
分账退款商户号 |
refund_amount |
Number(10,2) |
N |
分账退款金额 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_trade_refund_general_account_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节最大长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
refund_amount |
Number |
Y |
本次发生的退款金额 示例值:88.89 |
trade_no |
String(1,30) |
Y |
银盛支付平台的订单交易流水 示例值:311160414497667096 |
out_trade_no |
String(1,32) |
Y |
订单支付时传入的商户订单号 示例值:68431922806471166 |
account_date |
String(10) |
Y |
退款会计日期,格式"yyyy-MM-dd" 示例值:2014-07-24 |
out_request_no |
String(1,32) |
Y |
商户退款请求单号 示例值:RD2012061713107 |
refundsn |
String(1,32) |
Y |
银盛退款流水号 示例值:01R210622215530564 |
6.异步通知参数
银盛支付对商户的请求数据处理完成后,会将处理的结果数据通过服务器主动通知的方式通知给商户网站。这些处理结果数据就是服务器异步通知参数。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign_type |
String |
Y |
报文签名算法,交易请求时的签名类型RSA/SM |
sign |
String |
Y |
签名字符串,Base64编码 |
notify_type |
String |
Y |
通知类型 固定值:refund.status.sync |
notify_time |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
out_trade_no |
String(32) |
Y |
商户系统生成的退款订单号,对应的请求参数是out_request_no 示例值:RD2012061713107 |
total_amount |
Number |
N |
该笔退款订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。 |
trade_no |
String(20) |
N |
该交易在银盛支付系统中的交易流水号。 |
trade_status |
String |
Y |
交易目前所处的状态。成功状态的示例值: TRADE_SUCCESS |
account_date |
String(10) |
N |
入账的时间,格式"yyyyMMdd" 示例址:20140724 |
coupon_info |
String |
N |
JSON字符串,银联营销渠道响应优惠信,当原订单的version小于3.6版本的时候,为List的JSON字符串,如果大于等于3.6版本的时候为CouponInfo的JSON字符串 |
wxpay_refund_coupon_info |
String |
N |
微信优惠信息,原订单的版本号(version)在3.5及以上支持 |
alipay_refund_coupon_info |
String |
N |
支付宝优惠信息,原订单的版本号(version)版本号在3.5及以上支持 |
|settlement_amount |Number |N |原订单结算金额 示例值:100.00
6.1 银联 CupQrCouponDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
spnsrId |
double |
Y |
出资方,1:银联出资,2:付款方(比如银行)出资,3:商户出资offstAmt |
offstAmt |
double |
Y |
出资金额 ,单位为元 |
6.2 银联 CouponInfo
参数 |
类型(字节长度) |
必填 |
参数说明 |
amount |
Double |
Y |
清算金额 ,单位为元 |
origAmount |
Double |
Y |
订单金额, 单位为元,商户提交的订单金额 |
cupQrCouponDetail |
List |
N |
优惠信息-二维码,成功的二维码类交易交易必填,活动维度的优惠展示 |
issAddnData |
IssAddnData |
N |
付款方附加数据,交易成功返回,商品维度的优惠展示 |
cupAcpCouponInfo |
CupAcpCouponInfo |
N |
优惠信息全渠道,成功的全渠道类交易(如:Wap,手机控件 等)必填,活动维度的优惠展示 |
6.2.1 CupQrCouponDetail
参数 |
类型(字节长度) |
必填 |
参数说明 |
spnsrId |
double |
Y |
出资方,1:银联出资,2:付款方(比如银行)出资,3:商户出资offstAmt |
offstAmt |
double |
Y |
出资金额 ,单位为元 |
6.2.2 IssAddnData
参数 |
类型(字节长度) |
必填 |
参数说明 |
样例 |
dctDetail |
List |
N |
商品优惠信息 |
交易成功,且请求参数中的收款方附加信息域中的单品命中优惠。商品维度展示优惠信息。 |
6.2.2.1 DctDetail说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
id |
String |
Y |
参与优惠的商品编号 |
dctId |
String |
Y |
优惠活动的编号 |
dctQuantity |
int |
Y |
商品优惠数量,本商品数量为 10,其中 2 件参示例:本商品数量为 10,其中 2 件参 |
dctPrice |
double |
Y |
商品优惠金额,单位:元。示例:商品单价10元,共 5件,其中2件参与优惠,每件优惠 3元,则本字段值为 6.00 |
addnInfo |
String |
N |
附加信息,内容自定义 |
6.2.3 CupAcpCouponInfo说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
discountAmt |
double |
Y |
总的优惠金额,单位:元,注:退货的时候返回,表示总的优惠回退金额 |
mchtDiscountAmt |
double |
N |
商户出资金额,单位:元,注:退货的时候返回,表示商户出资的回退金额 |
activityId |
String |
N |
活动编号,票券编号、活动编号等,格式自定义 |
activityNm |
String |
N |
活动简称,优惠活动简称,可用于展示、打单等 |
addnPrintInfo |
String |
N |
活动打印信息,内容自定义 |
6.3 wxpay_refund_coupon_info说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
fee_type |
String |
N |
标价币种 |
refund_fee |
double |
N |
申请退款金额,单位:元 |
cash_refund_fee |
double |
N |
现金退款金额 |
settlement_refund_fee |
double |
N |
退款金额 (去掉非充值代金券退款金额后的退款金额,退款金额=申请退款金额-非充值代金券退款金额,退款金额<=申请退款金额) |
coupon_refund_fee |
double |
N |
代金券退款总金额 |
refundDetail |
refundDetail |
N |
优惠退款详情 |
ext |
String |
N |
额外的信息 |
6.3.1 refundDetail说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
promotion_id |
String(32) |
Y |
券 ID券或者立减优惠ID 例 109519 |
scope |
String(32) |
N |
优惠范围 GLOBAL- 全场代金券;SINGLE- 单品优惠 例 SINGLE |
type |
String(32) |
N |
优惠类型COUPON- 代金券,需要走结算资金的充值型代金券,(境外商户券币种与支付币种一致)DISCOUNT- 优惠券,不走结算资金的免充值型优惠券,(境外商户券币种与标价币种一致 例 DISCOUNT |
amount |
double |
Y |
用户享受优惠的金额(优惠券面额=微信出资金额+商家出资金额+其他出资方金额 ),单位:元 例 5.00 |
refund_amount |
double |
N |
退款金额 |
6.4 alipay_refund_coupon_info说明
参数 |
类型(字节长度) |
必填 |
参数说明 |
refund_fee |
double |
N |
申请退款金额,单位:元 |
refund_amount |
double |
N |
本次退款金额 |
send_back_fee |
double |
N |
本次商户实际退回金额 |
refundDetail |
String |
N |
退款支付时间 |
gmt_refund_pay |
String |
N |
优惠退款详情 |
ext |
String |
N |
额外的信息 |
present_refund_buyer_amount |
double |
N |
本次退款金额中买家退款金额 |
present_refund_discount_amount |
double |
N |
本次退款金额中平台优惠退款金额 |
present_refund_mdiscount_amount |
double |
N |
本次退款金额中商家优惠退款金额 |
7.样例
7.1 sdk调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://openapi.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\opensdk\\hyfz_test2.pfx";
String publicKeyFilePath = "D:\\opensdk\\businessgate.cer";
String privateKeyPassworde = "123456";
req.setPartnerId("hyfz_test2");
req.setReqUrl(reqUrl);
req.setPrivateKeyFilePath(privateKeyFilePath);
req.setPrivateKeyPassword(privateKeyPassworde);
req.setYsPublicKeyFilePath(publicKeyFilePath);
Map<String, Object> bizContent = new HashMap<>();
bizContent.put("out_trade_no", "20211012175144035102000788376200");
bizContent.put("shopdate", "20211012");
bizContent.put("trade_no", "01O211012233547058");
bizContent.put("refund_amount", "0.01");
bizContent.put("refund_reason", "不买了");
bizContent.put("out_request_no", "RD2012061713107");
bizContent.put("is_division", "01");
JSONArray refundSplitInfo = new JSONArray();
JSONObject infoObject = new JSONObject();
infoObject.put("refund_mer_id","y2110091506590197537");
infoObject.put("refund_amount","0.01");
refundSplitInfo.add(infoObject);
bizContent.put("refund_split_info", refundSplitInfo);
req.setParamData(bizContent);
String result = null;
try{
logger.info("一般消费户退款调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
result = MercFundApi.refundGeneralAccount(req);
}catch (Exception e){
logger.info("一般消费户退款失败:"+ e.getMessage());
}
7.2 refund_split_info
[{
"refund_mer_id": "分账退款商户号",
"refund_amount": "分账退款金额"
}]
8.附录
8.1 分账退款错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
系统错误 |
请使用相同的参数再次调用 |
ACQ.INVALID_PARAMETER |
参数无效 |
请求参数有错,重新检查请求后,再调用退款 |
ACQ.QUERY_NO_RECORD |
暂未查询到交易,请检查订单号/流水号后重试 |
该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询 |