快捷协议解约接口
1.修订记录
版本号 |
日期 |
说明 |
作者 |
V0.1 |
2018/06/25 |
新接口参数定义 |
邓鑫 |
V0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.业务说明
(1)场景说明
1、用户签约成功后,通过该接口可以进行解约操作
(2)接口说明
1、快捷协议解约接口
3.请求地址
4.参数说明
4.1公共请求参数
参数 |
类型(长度) |
Y |
参数说明 |
method |
String(128) |
Y |
接口名称 固定值 ysepay.trusteeship.sign.cancel |
partner_id |
String(20) |
Y |
在银盛支付开设的服务商商户号,请联系客户经理提供 |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 示例值:2014-07-24 03:07:50 |
charset |
String(10) |
Y |
商户网站使用的编码格式,如UTF-8、GBK、GB2312等,默认值 GBK |
sign_type |
String(10) |
Y |
报文签名算法,RSA/SM |
sign |
String(256) |
Y |
签名字符串,再用Base64编码 |
version |
String(3) |
Y |
接口版本3.0 当前版本 3.0 |
biz_content |
String |
Y |
业务请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递 |
4.2 业务请求参数
参数名biz_content,值为一个json格式对象,下面列表描述json对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
protocol_no |
String(20) |
Y |
银盛支付平台的签约流水号 示例值:K2018061401969840970 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_trusteeship_sign_cancel_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应代码 |
msg |
String |
Y |
响应代码描述 |
trade_status |
String(30) |
Y |
签约目前所处的状态。SUCCES:解约成功 ;FAILED:解约失败 |
sub_msg |
String(50) |
N |
返回信息 |
6.样例
6.1 SDK调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互。
@Test
public void mercSignCancel() throws Exception {
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://trusteeship.ysepay.com/gateway.do";
String privateKeyFilePath = "D:\\openRSA\\hyfz_test2.pfx";
String privateKeyPassworde = "123456";
String publicKeyFilePath = "D:\\openRSA\\businessgate.cer";
String partnerId = "hyfz_test2";
req.setPrivateKeyFilePath(privateKeyFilePath);
req.setPrivateKeyPassword(privateKeyPassworde);
req.setYsPublicKeyFilePath(publicKeyFilePath);
req.setReqUrl(reqUrl);
req.setPartnerId(partnerId);
Map<String,Object> bizContentMap = new HashMap<>();
bizContentMap.put("protocol_no","K2021101436720150055");
req.setParamData(bizContentMap);
logger.info("快捷协议解约请求入参为:"+ JSONObject.toJSONString(req));
String result = null;
try{
result = TrusteeshipApi.mercSignCancel(req);
}catch (Exception e){
logger.info("快捷协议解约失败:"+e.getCause().getMessage());
e.printStackTrace();
}
}
7.附录
7.1 请求错误码
错误码 |
错误描述 |
解决方案 |
ACQ.SYSTEM_ERROR |
接口返回错误 |
该笔解约异常 |
ACQ.INVALID_PARAMETER |
参数无效 |
检查请求参数,修改后重新发起请求 |
ACQ.ACCESS_FORBIDDEN |
无权限使用接口 |
联系银盛市场人员进行解约 |
7.2 交易状态
枚举名称 |
枚举说明 |
SUCCESS |
解约成功 |
FAILED |
解约失败 |