单笔代收协议签约授权

1.修订记录

2.接口说明

（1）场景说明

1、单笔代收协议签约授权

（2）接口说明

1、 单笔代收协议签约授权-V3.0版本

3.请求地址

4.单笔代收协议签约获取授权码

4.1公共请求参数

4.2 业务请求参数

参数名biz_content,值为一个json格式对象，下面列表描述json对象的值

5.单笔代收协议签约授权接口

5.1 公共请求参数

5.2 业务请求参数

参数名biz_content,值为一个json格式对象，下面列表描述json对象的值

5.3 响应参数说明

银盛支付对商户的短信验证码授权完成之后就会开始进行协议签约的处理，该同步返回指的是授权完成之后，银盛支付继续处理签约流程，授权接口会返回业务处理状态，短信验证码授权失败，那么会抛出异常。

请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况

5.3.1 公共响应参数

5.3.2 业务响应参数

6.异步通知参数说明

银盛支付在受理商户的协议签约请求，获取授权码请求，授权请求成功完成之后，会将协议签约的最终状态通过异步通知发送回给商户。

请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。

7.样例

7.1 sdk调用样例

• 银盛将与服务端交互的接口封装在开发工具包（SDK）中，开发者无需自行实现同服务端交互的复 杂逻辑，直接将SDK导入自己的工程后，通过sdk示例代码实现同银盛服务端的交互。

    ##########1、单笔代收协议签约获取授权码接口请求
    /**1、获取需要的参数*/
     //商户进件请求路径,建议配置在项目的配置文件里面
     String reqUrl = "https://ds.ysepay.com/gateway.do";

     //私钥证书存放路径,建议配置在项目的配置文件里面
     String privateKeyFilePath = "D:\\openRSA\\hyfz_test2.pfx";

     //ys公钥证书存放地址 建议配置在项目的配置文件里面
     String publicKeyFilePath = "D:\\openRSA\\businessgate.cer";

     //私钥证书密钥,建议配置在项目的配置文件里面
     String privateKeyPassworde = "123456";

     //商户在银盛支付平台开设的用户号[商户号],接入时需要替换成自己的
     String partnerId = "hyfz_test2";

     String notifyUrl = "http://127.0.0.1";
     /**2、组装需要的参数*/
     OnlineReqDataVo req = new OnlineReqDataVo();
     //设置私钥证书路径
     req.setPrivateKeyFilePath(privateKeyFilePath);
     //设置私钥密钥
     req.setPrivateKeyPassword(privateKeyPassworde);
     //设置ys公钥证书路径
     req.setYsPublicKeyFilePath(publicKeyFilePath);
     //设置请求路径
     req.setReqUrl(reqUrl);
     req.setPartnerId(partnerId);
     req.setNotifyUrl(notifyUrl);
     Map<String,Object>paramData = new LinkedHashMap<>();
     //客户企业两方协议号
     paramData.put("protocol_no","20211013000001");

     //业务员参数
     req.setParamData(paramData);


     logger.info("单笔代收协议签约获取授权码接口请求入参为:"+ JSONObject.toJSONString(req));

     /**2、调用API的方法*/
     String result = null;
     try{
         result = DsApi.singleProtocolAcceptGetAuthorizeMsgDs(req);
         JSONObject jsonObject = JSON.parseObject(result, Feature.OrderedField);

         //根据返回结果处理自己的业务逻辑,result内容详见接口文档
     }catch (Exception e){
         logger.info("单笔代收协议签约获取授权码接口失败:"+e.getCause().getMessage());

     }         

    ##########2、单笔代收协议签约授权接口请求
    /*1、获取需要的参数/ //商户进件请求路径,建议配置在项目的配置文件里面 String reqUrl = "https://ds.ysepay.com/gateway.do";

     //私钥证书存放路径,建议配置在项目的配置文件里面
     String privateKeyFilePath = "D:\\openRSA\\hyfz_test2.pfx";

     //ys公钥证书存放地址 建议配置在项目的配置文件里面
     String publicKeyFilePath = "D:\\openRSA\\businessgate.cer";

     //私钥证书密钥,建议配置在项目的配置文件里面
     String privateKeyPassworde = "123456";

     //商户在银盛支付平台开设的用户号[商户号],接入时需要替换成自己的
     String partnerId = "hyfz_test2";

     String notifyUrl = "http://127.0.0.1";
     /**2、组装需要的参数*/
     OnlineReqDataVo req = new OnlineReqDataVo();
     //设置私钥证书路径
     req.setPrivateKeyFilePath(privateKeyFilePath);
     //设置私钥密钥
     req.setPrivateKeyPassword(privateKeyPassworde);
     //设置ys公钥证书路径
     req.setYsPublicKeyFilePath(publicKeyFilePath);
     //设置请求路径
     req.setReqUrl(reqUrl);
     req.setPartnerId(partnerId);
     req.setNotifyUrl(notifyUrl);
     Map<String,Object>paramData = new LinkedHashMap<>();
     //客户企业两方协议号
     paramData.put("protocol_no","20211013000001");
     //银行预留手机号码
     paramData.put("bank_telephone_no","18512345678");
     //验证码
     paramData.put("mobile_verify_code","778666");

     //业务员参数
     req.setParamData(paramData);


     logger.info("单笔代收协议签约授权接口请求入参为:"+ JSONObject.toJSONString(req));

     /**2、调用API的方法*/
     String result = null;
     try{
         result = DsApi.singleProtocolAcceptGetAuthorizeDs(req);
         JSONObject jsonObject = JSON.parseObject(result, Feature.OrderedField);

         //根据返回结果处理自己的业务逻辑,result内容详见接口文档
     }catch (Exception e){
         logger.info("单笔代收协议签约授权接口请求失败:"+e.getCause().getMessage());

     }

8.附录

8.1 业务错误码

8.2 交易状态