单笔代收协议解约申请
1.修订记录
| 修订 |
日期 |
说明 |
作者 |
| V0.1 |
2020/5/14 |
新接口参数定义 |
宁华雄 |
| V0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
（1）场景说明
1、银联代收协议签约后，协议如果需要解约的，调用此接口
（2）接口说明
1、单笔代收协议解约-V3.0版本
3.请求地址
4.请求参数说明
4.1公共请求参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| method |
String(1,128) |
Y |
接口名称 固定值 ysepay.ds.protocol.unsign.accept |
| 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 |
| notify_url |
String(190) |
N |
银盛支付服务器主动通知商户网站里指定的页面http路径。 |
| biz_content |
String |
Y |
业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象，下面列表描述json对象的值
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| protocol_no |
String |
Y |
原代收签约协议号 |
5.同步返回参数说明
银盛支付对商户的短信验证码授权完成之后就会开始进行协议签约的处理，该同步返回指的是授权完成之后，银盛支付继续处理签约流程，授权接口会返回业务处理状态，如果短信验证码授权失败，那么会抛出异常。
请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| sign |
String |
Y |
签名字符串，Base64编码 |
| ysepay_ds_protocol_unsign_accept_respose |
String |
Y |
业务响应参数的集合，最大长度不限 |
5.2 业务响应参数
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| code |
String |
Y |
响应代码 |
| msg |
String |
Y |
响应代码描述 |
| out_trade_no |
String(1,32) |
Y |
原签约订单号 |
| shopdate |
String(8,8) |
Y |
原商户签约日期 |
| protocol_no |
String(1,32) |
Y |
原商户签约时银盛生产的协议号，交易用此协议号 |
| unsign_status |
String(1,32) |
Y |
解约状态UNSIGN_SUCCESSUNSIGN_FAILURE |
| unsign_status_description |
String(1,256 ) |
Y |
状态描述 |
6.异步返回参数说明
银盛支付在受理商户的协议签约请求，获取授权码请求，授权请求成功完成之后，会将协议签约的最终状态通过异步通知发送回给商户。
请注意:银盛后期对返回参数保留扩展的权利，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
| 参数 |
类型(字节长度） |
必填 |
参数说明 |
| out_trade_no |
String(1,32) |
Y |
原签约订单号 |
| shopdate |
String(8,8) |
Y |
原商户签约日期 |
| protocol_no |
String(1,32) |
Y |
原商户签约时银盛生产的协议号，交易用此协议号 |
| unsign_status |
String(1, 32) |
Y |
解约状态UNSIGN_SUCCESSUNSIGN_FAILURE |
| unsign_status_description |
String(1,256 ) |
Y |
状态描述 |
| notify_type |
String |
Y |
通知类型 固定值：ysepay.entrust.mer.unsign.single.notify |
| notify_time |
String(19) |
Y |
发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 示例值：2014-07-24 03:07:50 |
| sign_type |
String |
Y |
报文签名算法，交易请求时的签名类型RSA/SM |
| sign |
String |
Y |
签名串 |
7.样例
无
8.附录
8.1 业务错误码
| 错误码 |
错误描述 |
解决方案 |
| ACQ.SYSTEM_ERROR |
系统错误 |
请调用查询接口查询协议状态 |
| ACQ.BUSINESS_TIMEOUT_ERROR |
业务超时 |
请调用查询接口查询订单状态 |
| ACQ.SUB_SYS_CHECK_CUSTINFO |
该协议中存在空要素，业务检查不通过 |
调用查询接口查询协议的信息，并联系银盛客服处理 |
| ACQ.INVALID_PARAMETER |
无效的业务参数 |
找不到对应的客户信息，检查发起参数 |
| ACQ.SYSTEM_ERROR |
系统错误 |
请联系银盛客户或者市场技术支持 |
8.2 协议状态
| 枚举名称 |
枚举说明 |
| UNSIGN_SUCCESS |
协议解约成功 |
| UNSIGN_FAILURE |
协议解约失败 |