银联-单笔代收协议查询
1.修订记录
| 修订 |
日期 |
说明 |
作者 |
| V0.1 |
2020/05/14 |
重新整理老接口 |
宁华雄 |
| V0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
（1）场景说明
1、银联单笔代收协议签订后，需要进行协议状态查询的，调用此接口
（2）接口说明
1、单笔代收协议查询-V3.0版本
3.请求地址
4.请求参数说明
4.1 公共请求参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| method |
String(1,128) |
Y |
接口名称 固定值 ysepay.entrust.sign.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) |
N |
代收签约申请时的订单号，原签约协议号不为空时，优先使用协议号进行查询。如果原签约协议号为空时，原订单号和商户日期不可空。 |
| shopdate |
String(8,8) |
N |
商户系统的交易发生日期格式yyyyMMdd 示例值：20180525 |
| protocol_no |
String |
N |
原代收签约协议号 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串，Base64编码 |
| ysepay_entrust_sign_single_query_response |
String |
Y |
业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
银盛支付对商户的请求数据处理完成后，会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| code |
String |
Y |
响应代码 |
| msg |
String |
Y |
响应代码描述 |
| out_trade_no |
String(1,32) |
Y |
签约订单号，只能由大小写英文字母、数字、下划线及横杠组成 |
| shopdate |
String(8,8) |
Y |
商户系统的交易发生日期格式yyyyMMdd 示例值：20180525 |
| protocol_no |
String(1,32) |
Y |
银盛内部协议号 |
| protocol_status |
String(1,32) |
Y |
协议状态， SIGN_ACCEPT;SIGN_SUCCESS;SIGN_FAILURE;SIGN_REPEAT |
| protocol_status_description |
String(1,256) |
Y |
协议状态说明SIGN_SUCCESS:协议生效SIGN_ACCEPT:协议受理中SIGN_FAILURE:协议无效UNSIGN_SUCCESS:协议解约 |
6.样例
无
7.附录
7.1 业务错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
系统错误 |
请联系银盛客服 |
| ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
| ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数，修改后重新发起请求 |
| ACQ.QUERY_NO_RECORD |
暂未查询到记录 |
该状态为未知状态，请勿当成失败状态处理 检查传入的订单号是否正确，修改后重新发起请求或继续查询 |
7.2 协议状态
| 枚举名称 |
枚举说明 |
| SIGN_ACCEPT |
协议签约受理中 |
| SIGN_SUCCESS |
协议签约成功 |
| SIGN_FAILURE |
协议签约失败 |
| SIGN_REPEAT |
协议签约重复签约（签约失败） |