1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2018/01/29 |
新接口参数定义 |
黄月巧 |
V0.2 |
2018/4/12 |
新加同步返回“是否需要电子合同”字段,新加异步通知接口 |
黄月巧 |
V0.3 |
2018/9/26 |
注册新加客服电话,上传图片法人手持身份证正扫面照和门头照非必填 |
张丁元 |
V0.4 |
2018/12/05 |
更新notify_type参数说明 |
郭勇 |
V0.5 |
2019/01/17 |
新增参数:机构号org_no,分账参与商户标识sub_account_flag |
张丁元 |
V0.6 |
2019/01/17 |
异步通知增加字段online_url, offline_url |
陈宋东 |
V0.7 |
2019/07/03 |
补充图片上传注意事项 |
郭勇 |
V0.8 |
2020/06/04 |
需上传的图片需要新增50,51 |
宁华雄 |
V0.9 |
2020/10/10 |
不支持结算至贷记卡 |
汤吉齐 |
V1.0 |
2021/12/21 |
授权信息上送 |
刘雷 |
V1.1 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
(1)场景说明
1、线上子商户进件,包括口令获取、商户注册、注册查询、图片上传接口
2、需要调用口令获取(上传图片需要用到)、图片上传、注册接口进行注册
3、调用查询接口查看注册结果
(2)接口说明
1、商户进件上传口令获取、注册文本接口与查询接口-V3.0版本(新)
2、口令获取:调用接口获取token口令,在图片上传时需要此值
3、图片上传:根据token上传图片,调用商户注册接口时通过上传的token关联对应的图片
4、商户注册:传入商户资料进行子商户注册,注册成功返回子商户号
5、注册查询:商户注册结果未知时,调用接口获取商户注册状态
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(1,128) |
Y |
接口名称 获取上传口令接口:ysepay.merchant.register.token.get 商户注册接口:ysepay.merchant.register.accept 查询注册接口:ysepay.merchant.register.query |
partner_id |
String(1,20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(1,19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(1,10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(1,10) |
Y |
报文签名算法,RSA/SM |
sign |
String(1,256) |
Y |
签名字符串,再用Base64编码 |
notify_url |
String(190) |
Y |
银盛支付服务器主动通知商户网站里指定的页面http路径。 |
version |
String(1,3) |
Y |
接口版本3.0 当前版本:3.0 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
5.业务参数说明
参数名 biz_content,值为一个json格式对象,下面列表描述json对象的值
5.1 图片上传口令获取
5.1.1 图片上传口令获取
参数 |
类型(字节长度) |
必填 |
参数说明 |
样例 |
是否可为空 |
|
|
|
|
|
该请求为空参数(但是biz_content依然要求按照json格式填写),每次请求都会获取到一个 TOKEN(口令)字符串,您需要在有效时间内,凭此TOKEN上传图片文件至银盛文件服务器中以备注册使用。TOKEN有效时间为120s,一个TOKEN可以上传N张类型不同的图片文件,同类型的图片文件将以最近一次上传为准,为了提高注册成功率,请一次性将需要提高的图片信息全部上传。
图片上传地址:
生产环境:https://uploadApi.ysepay.com:2443/yspay-upload-service?method=upload
测试环境:https://cloudbilltest.ysepay.com:2080/yspay-upload-service?method=upload
图片上传完毕之后请发起商户注册请求,进行注册。注册接口中的token属性是您上传文件时使用的TOKEN值,您需要记住。
5.1.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
token |
String(32) |
Y |
token值 |
token_status |
String(20) |
Y |
获取TOKEN返回的状态,指示业务进度,TOKEN_GET_SUCCESS获取成功;TOKEN_GET_NULL获取失败 |
5.1.3 SDK调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互。
@Test
public void getToken() throws Exception {
/**1、获取需要的参数*/
OnlineReqDataVo req = new OnlineReqDataVo();
//获取图片上传token的请求路径,建议配置在项目的配置文件里面
String reqUrl = "https://register.ysepay.com:2443/register_gateway/gateway.do";
//客户端私钥证书路径: 证书是在入网流程中自己申请的
String privateKeyFilePath = "D:\\openRSA\\hyfz_test2.pfx";
//客户端私钥密钥: 私钥密钥在入网流程中自己申请私钥证书时填写的
String privateKeyPassworde = "123456";
//银盛公钥证书路径: 证书入网申请后随邮件发放
String publicKeyFilePath = "D:\\openRSA\\businessgate.cer";
//商户在银盛支付平台开设的用户号[商户号]:入网申请后发放
String partnerId = "hyfz_test2";
//银盛支付服务器主动通知商户网站里指定的页面http路径。
String notifyUrl = "http://127.0.0.1";
//设置私钥证书路径
req.setPrivateKeyFilePath(privateKeyFilePath);
//设置私钥密钥
req.setPrivateKeyPassword(privateKeyPassworde);
//设置ys公钥证书路径
req.setYsPublicKeyFilePath(publicKeyFilePath);
//设置请求路径
req.setReqUrl(reqUrl);
//设置通知路径
req.setNotifyUrl(notifyUrl);
req.setPartnerId(partnerId);
logger.info("获取图片上传token请求入参为:"+ JSONObject.toJSONString(req));
/**2、调用API的方法*/
String result = null;
try{
result = OnlineMercApi.getToken(req);
//根据返回结果处理自己的业务逻辑,result内容详见接口文档
}catch (Exception e){
logger.info("获取图片上传token失败:"+e.getCause().getMessage());
e.printStackTrace();
//根据自己要求处理业务逻辑
}
}
5.1.4 API接口代码示例
- 需要开发者自己封装调用逻辑,实现调用银盛api接口同银盛服务端交互,该示例没有加签验签及发送http请求代码,需自行下载demo查看。
@Test
public void getToken() throws Exception {
//组装公共请求参数
Map<String,String> mapDate = new HashMap<String, String>();
mapDate.put("method","ysepay.merchant.register.token.get");
mapDate.put("partner_id","hyfz_test2");
mapDate.put("timestamp", DateUtil.getDateNow());
mapDate.put("charset","UTF-8");
mapDate.put("sign_type","RSA");
mapDate.put("notify_url","http://127.0.0.1");
mapDate.put("version","3.0");
mapDate.put("biz_content","{}");
//进行参数签名,获取sign
try{
String sign = YsPaySignUtils.sign(mapDate);
log.info("产生的签名sign:"+sign);
mapDate.put("sign",sign);
}catch (Exception e){
log.info("签名异常:"+e);
}
//调用TOKEN获取接口
String result = HttpRequest.sendPost("https://register.ysepay.com:2443/register_gateway/gateway.do",CommonUtil.mapToString(mapDate));
if(StringUtil.isBlank(result)){
log.info("接口返回为空");