批量代付明细查询

1.修订记录

修订 日期 说明 作者
V0.1 2017/03/08 新接口参数定义 陈宋东
V0.2 2017/04/17 修改域名为searchdf.ysepay.com 陈宋东
V0.3 2017/6/20 将查询接口参数的非商户信息traed_no删除 黄月巧
V0.4 2017/6/29 开放查询类批次号长度为1-16 黄月巧
V0.5 2017/8/28 新增参数shopdate 黄月巧
V0.6 2017/9/18 公共参数新加proxy_password和merchant_usercode参数 黄月巧
V0.7 2017/10/20 新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) 陈宋东
V0.8 2018/06/27 新增三方手续费 郑明新
V0.9 2020/11/11 修改ACQ_QUERY_NO_RECORD的说明 汤吉齐
V1.0 2020/11/30 修改关于ACQ.SYSTEM_ERROR的中文描述 汤吉齐
V1.1 2021/01/21 修改关于ACQ.QUERY_NO_BATCH_RECORD的错误描述 王晶
V1.2 2021/01/21 修改关于ACQ.QUERY_NO_RECORD描述
V1.3 2021/12/27 支持国密 王晶

2.接口说明

(1)场景说明

1、批量代付时需查询明细

(2)接口说明

1、 批量代付明细查询接口

3.请求地址

环境 HTTPS请求地址
正式环境 https://searchdf.ysepay.com/gateway.do

4.请求参数说明

4.1 公共请求参数

参数 类型(字节长度) 必填 参数说明
method String(1,128) Y 接口名称。固定值:ysepay.df.batch.detail.query
partner_id String(1,20) Y 在银盛支付开设的服务商商户号,请联系客户经理提供
proxy_password String(50) N 代理密码,加密传输
merchant_usercode String(20) N 真实商户用户号,示例值:pinganyinhang02
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编码
version String(1,3) Y 接口版本3.0,当前版本3.0
biz_content String Y 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递

4.2 业务请求参数

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

参数 类型(字节长度) 必填 参数说明
out_batch_no String(1,16) Y 商户批次号,示例值:F201703081234567
out_trade_no String(1,32) Y 支付平台的订单号
shopdate String(8,8) Y 商户日期(该参数做交易与查询时需要一致) 该日期需在当日的前后一天时间范围之内,示例值:20170308

5.响应参数说明

银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。

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

5.1 公共响应参数

参数 类型(字节长度) 必填 参数说明
sign String Y 签名字符串,Base64编码
ysepay_df_batch_detail_query_response String Y 业务响应参数的集合,最大长度不限

5.2 业务响应参数

银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。

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

参数 类型(字节长度) 必填 参数说明
out_batch_no String(16,16) Y 商户批次号,格式:F+15位唯一流水,建议格式:F+YYYYMMDD+XXXXXXX,示例值:F201703081234567
out_trade_no String(1,32) Y 订单号
trade_status String(32) Y 交易目前所处的状态。状态的值:TRADE_ACCEPT_SUCCESS/TRADE_SUCCESS/TRADE_FAILURE|DISHONOUR_SUCCESS,示例值:8.2
trade_status_description String(256) N 状态描述,当trade_status为TRADE_FAILUR|DISHONOUR_SUCCESS时,该字段是代付失败或退票原因描述。该参数最长为128个汉字。示例值:代付银行号与姓名不一致
amount Number(10,2) Y 订单总金额。单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。
account_date String(1,10) N 会计日期:日账单格式为yyyyMMdd,示例值:20160413
trade_no String(30) N 交易流水
fee Number(10,2) N 参考总手续费,单位为:RMB Yuan。取值范围为[0.01,99999999.99],精确到小数点后两位。
partner_fee Number(10,2) Y 参考合作方手续费
payee_fee Number(10,2) Y 参考收款方手续费
payer_fee Number(10,2) Y 参考付款方手续费

6.样例

6.1 sdk样例

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

      /**1、获取需要的参数*/
      //商户进件请求路径,建议配置在项目的配置文件里面
      String reqUrl = "https://searchdf.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<>();
      //商户批次号,格式:F+15位唯一流水,建议格式:F+YYYYMMDD+XXXXXXX只能由大小写英文字母、数字、下划线及横杠组成
      paramData.put("out_batch_no","20211013000001");
      //支付平台的订单号
      paramData.put("out_trade_no","20211013000001");
      //商户日期
      paramData.put("shopdate","20211013");
    
      //业务参数
      req.setParamData(paramData);
      logger.info("批量代付查询请求入参为:"+ JSONObject.toJSONString(req));
    
      /**2、调用API的方法*/
      String result = null;
      try{
          result = DfApi.batchDetailQueryDf(req);
          JSONObject jsonObject = JSON.parseObject(result, Feature.OrderedField);
    
          //根据返回结果处理自己的业务逻辑,result内容详见接口文档
      }catch (Exception e){
          logger.info("批量代付查询失败:"+e.getCause().getMessage());
    
      }
    

7.附录

7.1 业务错误码

错误码 错误描述 解决方案
ACQ.SYSTEM_ERROR 系统错误 支付中该状态为未知状态,请勿当成失败状态处理,请等待支付通知或继续查询
ACQ.BUSINESS_TIMEOUT_ERROR 业务超时 请调用查询接口查询订单状态
ACQ.INVALID_PARAMETER 参数无效 检查请求参数,修改后重新发起请求
ACQ.BATCH_DETAIL_PROCESSING 批次明细处理中 批次明细处理中,请稍后查询
ACQ.QUERY_NO_BATCH_RECORD 暂未查询到该批次记录 检查partner_id/out_batch_no/out_trade_no/shopdate后重试
ACQ.QUERY_NO_RECORD 暂未查询到记录,检查partner_id/out_batch_no/out_trade_no/shopdate后重试 该状态为未知状态,请勿当成失败状态处理 检查传入的订单号是否正确,修改后重新发起请求或继续查询
ACQ.SHOPDATE_VALID_FAILD 商户日期获取失败 检查参数
ACQ.PROXY_CHECK_FAILD 代理关系检查失败 比如委托关系不存在
ACQ.PROXY_CHECK_PARAM 代理关系参数验证失败 比如代理密码解密失败,或者代理密码与委托商户号没有同时传或者同时不传

7.2 交易状态

枚举名称 枚举说明
TRADE_ACCEPT_SUCCESS 受理成功。
TRADE_SUCCESS 明细交易成功
TRADE_FAILURE 明细交易失败
DISHONOUR_SUCCESS 明细退票成功

results matching ""

    No results matching ""