单笔代收对账单下载地址获取接口
1.修订记录
修订 | 日期 | 说明 | 作者 |
---|---|---|---|
V0.1 | 2017/5/4 | 新接口参数定义 | 陈宋东 |
V0.2 | 2016/8/8 | 业务错误码优化 | 陈宋东 |
V0.3 | 2017/10/16 | 删除业务错误码ACQ.FILE_TYPE_NOT_EXIST, | 陈宋东 |
V0.4 | 2017/10/20 | 新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR(业务超时) | 陈宋东 |
V0.5 | 2021/12/27 | 支持国密 | 王晶 |
2.接口说明
(1)场景说明
1、单笔代收对账单下载地址获取
(2)接口说明
1、单笔代收对账单下载地址获取接口
3.请求地址
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://searchds.ysepay.com/gateway.do |
4.请求参数说明
4.1公共请求参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
method | String(1,128) | Y | 接口名称。固定值:ysepay.ds.bill.downloadurl.get |
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编码 |
version | String(1,3) | Y | 接口版本,示例值:3.0 |
biz_content | String | Y | 业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
account_date | String(1,10) | Y | 会计日期:日账单格式为yyyy-MM-dd,示例值:2016-04-13 |
5.同步返回参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
sign | String | Y | 签名字符串,Base64编码 |
ysepay_ds_bill_downloadurl_get_respose | String | Y | 业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 | 类型(字节长度) | 必填 | 参数说明 |
---|---|---|---|
code | String | Y | 响应代码 |
msg | String | Y | 响应代码描述 |
bill_download_url | String(1,2048) | Y | 账单下载地址链接,获取连接后30秒后未下载,链接地址失效。示例值:http://download.ysepay.com/Cv1dF1Cuy8ezofoFAAADB_ClX6I350.zip |
6.样例
无
7.附录
7.1 业务错误码
错误码 | 错误描述 | 解决方案 |
---|---|---|
ACQ.SYSTEM_ERROR | 系统错误 | 重新发起请求 |
ACQ.BUSINESS_TIMEOUT_ERROR | 业务超时 | 请调用查询接口查询订单状态 |
ACQ.INVALID_PARAMETER | 参数校验错误 | 请检查请求参数,修改后重新发起请求 |
ACQ.BILL_FILE_NOT_GENERATE | 对账文件尚未生成 | 请耐心等待,该对账文件尚未生成,稍后重新发起请求 |
ACQ.NOT_TRANSACTION_RECORD_ON_THE_DAY | 该商户当天无交易 | 核查账单日期有无交易 |
ACQ.BILL_FILE_GENERATE_FAIL | 对账文件生成失败 | 请稍后再试,如还有问题,请联系银盛 |
ACQ.SYSTEM_BUSY | 系统繁忙 | 请稍后再试,如还有问题,请联系银盛 |
ACQ.TOKEN_IS_NOT_EXIST | 该标识对应的对账文件不存在 | 请核查标识是否最新,如还有问题,请联系银盛 |
ACQ.DOWNLOAD_BILL_FILE_TIMEOUT | 下载超时 | 请重新发起,标识已过期(过期时间:30s) |
ACQ.BILL_FILE_EXPIRE | 该对账文件过期,已清除 | |
ACQ.PROXY_CHECK_FAILD | 代理关系检查失败 | 比如委托关系不存在 |
ACQ.PROXY_CHECK_PARAM | 代理关系参数验证失败 | 比如代理密码解密失败,或者代理密码与委托商户号没有同时传或者同时不传 |