分账对账单下载地址
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2019/2/22 |
新接口参数定义 |
邓文泉 |
V0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
(1)场景说明
1、分账交易处理完成后,可以下载对账单对交易进行查询
2、调用此接口获取分账对账单的地址
3、根据地址获取分账对账单文档
(2)接口说明
1、分账对账单下载地址接口
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.online.division.downloadurl.get |
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对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
account_date |
String(10) |
Y |
会计日期:日账单格式为yyyy-MM-dd 示例值:2016-04-13 |
5.返回参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_online_division_downloadurl_get_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
bill_download_url |
String(2048) |
Y |
账单下载地址链接,获取连接后30秒后未下载,链接地址失效 |
code |
String(20) |
Y |
返回码 示例值:附录8.2 |
msg |
String(100) |
Y |
返回码说明 |
5.3 对账单地址
示例值:
http://download.ysepay.com/ divDownload/Z3JvdXAxLE0wMC8wMS9BMS9DdFVpSTF4bUl2MkVIYUxsQUFBQUFEMHlMSVE2NjEyMzUx?fileName=DIVISION_CHK_09_20181120.txt&token=TK20190222133339468kOtqLIK8
6.样例
6.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("account_date", "2021-10-12");
req.setParamData(bizContent);
String result = null;
try{
logger.info("分账对账单下载调用sdk接口addScanMerc请求入参为:"+ JSONObject.toJSONString(req));
result = MercFundApi.divisionDownloadUrl(req);
}catch (Exception e){
logger.info("分账对账单下载接口失败:"+ e.getMessage());
}
7.附录
7.1 对账单业务错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
系统错误 |
重新发起请求 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
ACQ.TOKEN_INVALID |
请获取最新的下载对账单URL,并在30秒内有效 |
重新发起请求 |
7.2 交易状态
code |
msg |
SUCCESS |
状态成功,对账单文件生成成功,可以进行业务处理。 |
FAILURE |
状态失败,对账单文件生成失败。 |
7.3 对账单文件说明
对账单文件格式为txt,开发文档文件名、字段会不断扩展,开发时请注意兼容性。
对账单内容格式,字段以”,”分隔:
订单号,流水号,交易会计日期,分账商户号,交易类型,交易金额,手续费,批次号,分账类型
示例:20221008193624588POS100,01Q221008006898011_0001,20221008,zhaoh08,09,41.00,0.19,,02
交易类型说明:01-消费;02-联机退货;03-撤销;04-冲正;06-手工退货;08-转账;09-订单支付;10-代收;11-代付;12-代付退票
分账类型说明:01的是原流水 02的是分账流水和反冲流水 如果是分账流水,就是分账金额,如果是原流水或者反冲流水就是交易金额