批量代付汇总+明细查询
1.修订记录
| 修订 |
日期 |
说明 |
作者 |
| V0.1 |
2018/08/20 |
新接口参数定义 |
陈宋东 |
| V0.2 |
2020/11/30 |
修改关于ACQ.SYSTEM_ERROR的中文描述 |
汤吉齐 |
| V0.3 |
2021/01/21 |
修改关于ACQ.QUERY_NO_BATCH_RECORD的错误描述 |
王晶 |
| V0.4 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
（1）场景说明
1、批量代付时需查询明细
（2）接口说明
1、 批量代付明细查询接口
3.请求地址
4.请求参数说明
4.1公共请求参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| method |
String(1,128) |
Y |
接口名称，固定值：ysepay.df.batch.summary.detail.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编码 |
| version |
String(1,3) |
Y |
接口版本 默认值 3.0 |
| biz_content |
String |
Y |
业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_batch_no |
String(1,16) |
Y |
商户批次号,示例值：F201703081234567 |
| shopdate |
String(8,8) |
Y |
商户日期，示例值：20170308 |
5.同步返回参数
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串，Base64编码 |
| ysepay_df_batch_summary_detail_query_response |
String |
Y |
业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| code |
String |
Y |
响应代码 |
| msg |
String |
Y |
响应代码描述 |
| out_batch_no |
String(16,16) |
Y |
商户批次号,格式：F+15位唯一流水，建议格式：F+YYYYMMDD+XXXXXXX，示例值：F201703081234567 |
| batch_no |
String(1，30) |
Y |
批次流水号 |
| trade_status |
String（1，32） |
Y |
交易目前所处的状态。状态的值可为：BATCH_TRADE_SUCCESS等值，示例值：7.2 |
| trade_status_description |
String（256) |
N |
状态描述，当trade_status为BATCH_TRADE_SUCCESS时，该字段是批次状态的描述。该参数最长为128个汉字。示例值：批次交易处理完成 |
| total_amount |
Number(12，2) |
Y |
总金额 |
| total_num |
String(1,4) |
Y |
总笔数 |
| success_total_amount |
Number(12，2) |
Y |
成功总金额 |
| success_total_num |
String(1,4) |
Y |
成功总笔数 |
| batch_account_date |
String(1，10) |
N |
批次会计日期：日账单格式为yyyyMMdd，示例值：20160413 |
| detail_data |
list |
N |
代付详细数据，最多支持2000笔。Json数组格式，暂包括out_trade_no、amount、subject、bank_name、bank_province、bank_city、bank_account_no、bank_account_name、bank_account_name、bank_card_type，示例值：6.1 |
|
|
|
5.3 代付列表 detail_data
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
订单号 |
| trade_status |
String（32） |
Y |
交易目前所处的状态。状态的值：TRADE_ACCEPT_SUCCESS\ |
TRADE_SUCCESS，TRADE_FAILURE\ |
DISHONOUR_SUCCESS 示例值：8.3 |
| trade_status_description |
String（256) |
Y |
状态描述，当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) |
Y |
参考总手续费,单位为：RMB Yuan。取值范围为[0.00，99999999.99]，精确到小数点后两位。 |
| partner_fee |
Number(10，2) |
Y |
参考合作方手续费 |
| payee_fee |
Number(10，2) |
Y |
参考收款方手续费 |
| payer_fee |
Number(10，2) |
Y |
参考付款方手续费 |
6.样例
6.1 代付列表 detail_data
[{
"out_trade_no":"201703080768835",
"amount":"1.5",
"subject":"订单说明",
"bank_name":"中国银行深圳民治支行",
"bank_province":"广东省",
"bank_city":"深圳市",
"bank_account_no":"1111111111111111",
"bank_account_name":"姓名",
"bank_account_type":"personal",
"bank_card_type":"credit"
},..]
7.附录
7.1 业务错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
系统错误 |
支付中该状态为未知状态，请勿当成失败状态处理，请等待支付通知或继续查询 |
| ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
| ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数，修改后重新发起请求 |
| ACQ.QUERY_NO_BATCH_RECORD |
暂未查询到该批次记录 |
请检查partner_id/out_batch_no/out_trade_no/shopdate后重试 |
7.2 批次交易状态
| 枚举名称 |
枚举说明 |
| BATCH_ACCEPT_SUCCESS |
批次受理成功。 |
| BATCH_TRADE_SUCCESS |
批次交易处理完成 |
| BATCH_TRADE_FAILURE |
批次交易处理失败 |
7.3 明细交易状态
| 枚举名称 |
枚举说明 |
| TRADE_ACCEPT_SUCCESS |
受理成功。 |
| TRADE_SUCCESS |
明细交易成功 |
| TRADE_FAILURE |
明细交易失败 |
| DISHONOUR_SUCCESS |
明细退票成功 |