查询微信实名认证授权状态
1.修订记录
修订 |
日期 |
说明 |
作者 |
V0.1 |
2020.11.11 |
新接口参数定义 |
汤吉齐 |
V0.2 |
2021/12/27 |
支持国密 |
王晶 |
2.接口说明
(1)场景说明
1、微信实名认证授权状态查询
(2)接口说明
1、 微信实名认证授权状态查询接口
3.请求地址
4.请求参数说明
4.1 公共请求参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
method |
String(128) |
Y |
接口名称。示例值:ysepay.authenticate.wx.authorized.query |
partner_id |
String(20) |
Y |
商户在银盛支付平台开设的用户号[商户号] |
timestamp |
String(19) |
Y |
发送请求的时间,格式"yyyy-MM-dd HH:mm:ss",示例值:2020-11-11 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对象的值
参数 |
类型(字节长度) |
必填 |
参数说明 |
usercode |
String(1,50) |
Y |
商户号,示例值:826513086510202 |
5.响应参数说明
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
5.1 公共响应参数
参数 |
类型(字节长度) |
必填 |
参数说明 |
sign |
String |
Y |
签名字符串,Base64编码 |
ysepay_authenticate_wx_authorized_query_response |
String |
Y |
业务响应参数的集合,最大长度不限 |
5.2 业务响应参数
银盛支付对商户的请求数据处理完成后,会将处理的结果数据同步回执给商户。
请注意:银盛后期对返回参数保留扩展的权利,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。
参数 |
类型(字节长度) |
必填 |
参数说明 |
code |
String |
Y |
响应码,示例值:10000 |
msg |
String |
Y |
返回信息,示例值:Success表示成功;业务异常表示出现了异常 |
sub_code |
String |
N |
具体的错误码,示例值:ACQ.SYSTEM_ERROR:表示系统错误;ACQ.MERCHANT_NO_ERROR:表示商户名不存在;ACQ.QUERY_NO_RECORD:表示无记录 |
sub_msg |
String |
N |
具体的错误信息,示例值:系统错误;调用条码查询出错 |
thirdparty_mercid_x |
String |
N |
第三方商户号1 |
thirdparty_authstate_x |
String |
N |
第三方商户号1授权状态,示例值:第三方商户号1对应的授权状态 |
thirdparty_mercid_y |
String |
N |
第三方商户号2 |
thirdparty_authstate_y |
String |
N |
第三方商户号2授权状态,示例值:第三方商户号2对应的授权状态 |
note_x |
String |
N |
第三方商户号1的描述 |
note_y |
String |
N |
第三方商户号2的描述 |
上送的商户号可能对应了微信的1个或2个第三方商户号,所以当有两个第三方商户的时候thirdparty_mercid_y ,thirdparty_authstate_y 会有值。
5.3 thirdparty_authstate_x|y参数
value |
mean |
AUTHORIZE_STATE_UNAUTHORIZED |
未授权 |
AUTHORIZE_STATE_AUTHORIZED |
已授权 |
6.样例
6.1 SDK调用示例
- 银盛将与服务端交互的接口封装在开发工具包(SDK)中,开发者无需自行实现同服务端交互的复杂逻辑,直接将SDK导入自己的工程后,通过sdk示例代码实现同银盛服务端的交互。
@Test
public void queryWxAuthorized() throws Exception {
OnlineReqDataVo req = new OnlineReqDataVo();
String reqUrl = "https://openapi.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("usercode","hyfz_test2");
req.setParamData(bizContentMap);
logger.info("查询微信实名认证授权状态请求入参为:"+ JSONObject.toJSONString(req));
String result = null;
try{
result = WxAuthorApi.queryWxAuthorized(req);
}catch (Exception e){
logger.info("查询微信实名认证授权状态失败:"+e.getCause().getMessage());
e.printStackTrace();
}
}
7.附录
7.1 业务错误码
错误码 |
错误描述 |
解决方案 |
ACQ.WX_AUTHEN_STATE_ERROR |
系统错误 |
请重新调用查询申请单状态接口 |
WX_AUTHEN_STATE_NO_RECORD |
查询记录为空 |
检查请求商户号,修改后重新发起请求 |