银联-单笔代收查询
1.修订记录
| 修订 |
日期 |
说明 |
作者 |
| V0.1 |
2017/04/28 |
新接口参数定义 |
陈宋东 |
| V0.2 |
2017/06/20 |
将查询接口参数的非商户信息trade_no删除 |
黄月巧 |
| V0.3 |
2017/06/30 |
新增交易状态TRADE_WAIT_AUTH和GET_AUTH_CODE |
陈宋东 |
| V0.4 |
2017/8/28 |
新增参数shopdate |
黄月巧 |
| V0.5 |
2017/10/20 |
新增异常类型ACQ.BUSINESS_TIMEOUT_ERROR（业务超时） |
陈宋东 |
| V0.6 |
2020/11/11 |
修改ACQ_QUERY_NO_RECORD的说明 |
汤吉齐 |
| V0.7 |
2021/01/21 |
修改ACQ_QUERY_NO_RECORD的错误描述 |
王晶 |
| V0.8 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
（1）场景说明
1、银联-单笔代收查询-V3.0版本
（2）接口说明
1、单笔代收查询-V3.0版本
3.请求地址
4.请求参数说明
4.1 公共请求参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| method |
String(1,128) |
Y |
接口名称 固定值 ysepay.ds.single.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 当前版本：3.0 |
| biz_content |
String |
Y |
业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号，代收交易订单号 |
| shopdate |
String(8,8) |
Y |
商户系统的交易发生日期格式yyyyMMdd 示例值：20180525 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串，Base64编码 |
| ysepay_ds_single_query_response |
String |
Y |
业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
商户系统生成的订单号 |
| trade_status |
String（32） |
Y |
交易目前所处的状态。状态的值：TRADE_ACCEPT_SUCCESS｜TRADE_SUCCESS｜TRADE_FAILURE 示例值：附录8.2 |
| trade_status_description |
String（256) |
N |
状态描述，当trade_status为TRADE_FAILURE时，该字段是失败原因描述。该参数最长为128个汉字。 |
| total_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.样例
无
7.附录
7.1 业务错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
系统错误 |
请联系银盛客服 |
| ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
| ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数，修改后重新发起请求 |
| ACQ.QUERY_NO_RECORD |
暂未查询到记录，请检查partner_id/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 |
交易失败 |
| TRADE_WAIT_AUTH |
交易待授权,当出现该状态时，是因为商户配置了”代收交易下发短信校验”，需要执行“单笔代收交易授权-V3.0版本.docx”的获取授权码和授权接口 |
| GET_AUTH_CODE |
已获取授权码 |