快捷协议签约接口
1.修订记录
版本 |
日期 |
说明 |
作者 |
V0.1 |
2018/05/28 |
新接口参数定义 |
邓鑫 |
V0.2 |
2018/07/05 |
新增支付作用范围 |
邓文泉 |
V0.3 |
2019/03/18 |
新增签约金额 |
邓鑫 |
V0.4 |
2021/12/27 |
支持国密 |
王晶 |
2.业务说明
(1)场景说明
用户签约成功后,通过该接口可以创建无卡快捷订单及明细登记 协议快捷支付流程: 1、协议签约接口签约; 2、协议签约后,会收到短信验证码,再调用协议签约确认接口进行确认; 3、协议签约确认完成后,调用创建无卡快捷订单及明细登记接口订单创建; 4、创建无卡快捷订单及明细登记后,会收到短信验证码,调用确认协议快捷支付短信接口进行确认支付; 5、如果没有收到协议快捷短信验证码,调用重新获取协议快捷支付短信接口再发送短信验证码进行确认支付;
(2)接口说明
1、商户签约接快捷支付业务交易之前,需作协议签约,才能正式交易口
3.请求地址
4.参数说明
4.1公共请求参数
参数 |
类型(长度) |
Y |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.trusteeship.sign |
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 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号,生成规则前8位必须为交易日期,如20180525,范围跨度支持包含当天在内的前后一天,且只能由大小写英文字母、数字、下划线及横杠组成 示例值:201805256843192280647118 |
seller_id |
String(1,20) |
Y |
收款商户号(银盛支付生成并下发) |
seller_name |
String(1,50) |
Y |
收款方银盛支付客户名 |
buyer_name |
String(1,50) |
Y |
付款方银行姓名,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格;如果签名方式为SM,则用SM加密 |
buyer_card_number |
String(1,32) |
Y |
付款方银行账号,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格; 如果签名方式为SM,则用SM加密 |
buyer_mobile |
String(0,11) |
Y |
付款方银行绑定手机号码,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格; 如果签名方式为SM,则用SM加密 |
cardCvn2 |
String(3) |
N |
贷记卡必填,cvv,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格; 如果签名方式为SM,则用SM加密 |
cardExprDt |
String(4) |
N |
贷记卡必填,有效日期,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格,格式为MMYY; 如果签名方式为SM,则用SM加密 |
pyerIDNo |
String(15\ |
18) |
Y |
证件号码,目前只支持身份证,如果签名方式为RSA,则用DES加密,密钥为商户号partner_id前8位,不足8位在商户号前补空格; 如果签名方式为SM,则用SM加密 |
user_id |
String(25) |
Y |
唯一客户标识,商户旗下客户号 |
imei |
String(25) |
N |
手机串号 |
actionScope |
String(2) |
N |
支付作用范围01:发起方 + 收款方 + 商户旗下客户 + 持卡人(四要素) , 默认02:发起方 + 商户旗下客户 + 持卡人(四要素) |
total_amount |
Number(10,2) |
N |
该笔订单的资金总额,单位为RMB-Yuan。取值范围为[0.01,100000000.00],精确到小数点后两位。Number(10,2)指10位长度,2位精度 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_trusteeship_sign |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号 |
protocol_no |
String(20) |
N |
银盛支付平台的签约流水号 示例值:RD2012061 |
trade_status |
String(30) |
Y |
签约目前所处的状态。SUCCESS:签约成功 ;WAIT_CONFIRM:签约登记成功(需要再次调用签约确认);FAILED:签约登记失败 |
sub_msg |
String(50) |
N |
返回信息 |
6.样例
6.1 SDK调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互。
@Test
public void mercSign() throws Exception {
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://trusteeship.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\openRSA\\hyfz_test2.pfx";
String privateKeyPassworde = "123456";
String publicKeyFilePath = "D:\\openRSA\\businessgate.cer";
String partnerId = "hyfz_test2";
req.setPrivateKeyFilePath(privateKeyFilePath);
req.setPrivateKeyPassword(privateKeyPassworde);
req.setYsPublicKeyFilePath(publicKeyFilePath);
req.setReqUrl(reqUrl);
req.setPartnerId(partnerId);
Map<String,Object> bizContentMap = new HashMap<>();
bizContentMap.put("out_trade_no","20211015843192280647222");
bizContentMap.put("seller_id","hyfz_test2");
bizContentMap.put("seller_name","银盛支付服务股份有限公司行业发展部");
bizContentMap.put("buyer_name",SrcDesUtil.encryptData(partnerId,"张三"));
bizContentMap.put("buyer_card_number",SrcDesUtil.encryptData(partnerId,"623422423423423720711"));
bizContentMap.put("buyer_mobile",SrcDesUtil.encryptData(partnerId,"15523423463"));
bizContentMap.put("cardCvn2", SrcDesUtil.encryptData(partnerId,"6234252342342234234211"));
bizContentMap.put("cardExprDt",SrcDesUtil.encryptData(partnerId,"20250923"));
bizContentMap.put("pyerIDNo",SrcDesUtil.encryptData(partnerId,"430626132424234343716"));
bizContentMap.put("user_id","hyfz_test2");
bizContentMap.put("imei",null);
bizContentMap.put("actionScope","01");
bizContentMap.put("total_amount","100");
req.setParamData(bizContentMap);
logger.info("商户签约申请请求入参为:"+ JSONObject.toJSONString(req));
String result = null;
try{
result = TrusteeshipApi.mercSign(req);
}catch (Exception e){
logger.info("商户签约申请失败:"+e.getCause().getMessage());
e.printStackTrace();
}
}
6.2 API接口代码示例
- 需要开发者自己封装调用逻辑,实现调用银盛api接口同银盛服务端交互,该示例没有加签验签及发送http请求代码,需自行下载demo查看。
public static void signAgreeController() throws Exception {
Map<String, String> mapData = new HashMap<String, String>();
mapData.put("method", "ysepay.trusteeship.sign");
mapData.put("partner_id", "test");
mapData.put("timestamp", DateUtil.getDateNow());
mapData.put("charset", "utf-8");
mapData.put("sign_type", "RSA");
mapData.put("version", "3.0");
JSONObject json = new JSONObject();
json.put("out_trade_no", DateUtil.getDateNowYmd() + DateUtil.getRandom(6));
json.put("seller_id", "test");
json.put("seller_name", "杭州杭榕企业发展有限公司");
json.put("buyer_name", SrcDesUtil.encryptData("cws123456","钟**"));
json.put("buyer_card_number",SrcDesUtil.encryptData("cws123456","6217*************22"));
json.put("buyer_mobile", SrcDesUtil.encryptData("cws123456","187******33"));
json.put("pyerIDNo", SrcDesUtil.encryptData("cws123456","36***************1"));
json.put("user_id", "1118797813533");
mapData.put("biz_content", json.toString());
try {
System.out.println("待签名内容map:" + mapData.toString());
String sign = YsPaySignUtils.sign(mapData);
mapData.put("sign", sign);
System.out.println("签名完成内容:" + mapData.toString());
} catch (Exception e) {
System.out.println("签名异常,异常信息{" + e);
}
String result = HttpRequest.sendPost("https://trusteeship.ysepay.com/gateway.do", CommonUtil.mapToString(mapData));
System.out.println("同步返回结果:" + result);
}
7.附录
7.1 签约错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
接口返回错误 |
该笔签约订单异常 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
ACQ.ACCESS_FORBIDDEN |
无权限使用接口 |
联系银盛市场人员进行签约 |
7.2 交易状态
枚举名称 |
枚举说明 |
SUCCESS |
签约成功 |
WAIT_CONFIRM |
签约登记成功(需要再次调用签约确认) |
FAILED |
签约失败 |