zhima.customer.auth.mutualview.apply(芝麻信用互查申请) 在线调试(沙箱环境)

适用于用户在芝麻信用中互查芝麻分

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.customer.auth.mutualview.apply
format String 40 仅支持JSON JSON
return_url String 256 HTTP/HTTPS开头字符串 https://m.alipay.com/Gk8NF23
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_param String 必选 500 当前业务产品的产品码,接口提供方分配,填写的值即是示例值中的值 {"productCode":"w1010100001000002181"}
biz_type String 必选 32 当前业务操作是查询自己还是查询别人的芝麻分,接口提供方分配的值:
self :标识查询自己的分数或者做业务授权时也需要传入此值
other : 标识需要查询别人的分数
self
identity_param String 必选 1000 个人身份信息入参:
1. 若做业务授权请求请传入身份三要素,如下:
{"certType":"IDENTITY_CARD","name":"张三","certNo":"654326198805xxxx9"}
2. 若为查询自己或者别人的信用状态,请传入userId,如下:
{"userId":"2088xxxx281848"}

针对各个字段的描述如下:
certType:证件类型固定为身份证,传入IDENTITY_CARD;
name:用户姓名,如张三
certNo:身份证号码
userId:此值为查询时的必要入参,此值的来源为授权完成后返回的auth_id字段,可以参见接口返回值中的出参
{"certType":"IDENTITY_CARD","name":"kglvgu","certNo":"654326198005300549","userId":"2088302408281848"}
callback_url String 必选 1000 商户回调的url,业务操作完成后会在此url上追加返回参数 taobao://detail.m.tmall.com/item.htm?id=xxx
ext_biz_param String 可选 1000 用户传递扩展类的信息,例如传入当前用户的logo,昵称等,用于业务页面上的展示,此值为一个Map类型的json串字符,传入规则如下:
{"key1":"val2","key2":"val2"}
{"nickName":"lily","icon":"http://xxx.png","outerSign":"xyz"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
auth_id String 选填 32 查询用户信用状态的id 2088302408281848
describe String 选填 64 用于展示本次查询结果的描述,例如信用良好,信用一般 信用良好
cancel_result String 选填 32 取消授权结果,true为成功,false为失败,其他值表示非取消授权的操作 true
outer_sign String 选填 500 此值接口提供方不做消费,仅用来给商户端透传的字段;用于商户端在调用此接口时回传到自己的业务逻辑中,用于自己的业务逻辑校验使用的;
此值的来源参见接口入参中的ext_biz_param中
xyz
error_code String 选填 32 本次业务操作的错误码 ZM_AUTH_NOT_EXIST
error_message String 选填 64 本次业务操作的错误描述 授权不存在

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaCustomerAuthMutualviewApplyRequest request = new ZhimaCustomerAuthMutualviewApplyRequest();
request.setBizContent("{" +
"\"product_param\":\"{\\\"productCode\\\":\\\"w1010100001000002181\\\"}\"," +
"\"biz_type\":\"self\"," +
"\"identity_param\":\"{\\\"certType\\\":\\\"IDENTITY_CARD\\\",\\\"name\\\":\\\"kglvgu\\\",\\\"certNo\\\":\\\"654326198005300549\\\",\\\"userId\\\":\\\"2088302408281848\\\"}\"," +
"\"callback_url\":\"taobao://detail.m.tmall.com/item.htm?id=xxx\"," +
"\"ext_biz_param\":\"{\\\"nickName\\\":\\\"lily\\\",\\\"icon\\\":\\\"http://xxx.png\\\",\\\"outerSign\\\":\\\"xyz\\\"}\"" +
"  }");
ZhimaCustomerAuthMutualviewApplyResponse response = alipayClient.pageExecute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_customer_auth_mutualview_apply_response": {
        "code": "10000",
        "msg": "Success",
        "auth_id": "2088302408281848",
        "describe": "信用良好",
        "cancel_result": "true",
        "outer_sign": "xyz",
        "error_code": "ZM_AUTH_NOT_EXIST",
        "error_message": "授权不存在"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "zhima_customer_auth_mutualview_apply_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_FAILURE 系统繁忙 系统繁忙,请稍后再试
ZM_ACCOUNT_NOT_EXISTED 用户未开通芝麻账户 请根据页面引导开通账户后重试
ZM_AUTH_NOT_EXIST 授权记录不存在 请根据页面引导完成信用授权后重试
ZM_CREDIT_SCORE_QUERY_FAIL 查询芝麻分失败 网络问题,请稍后再试
ALIPAY_NOT_REAL_NAME_CERTIFY 用户未进行支付宝实名认证 请进行支付宝实名认证后重试
ALIPAY_RELATED_UNKNOW 当前登录账户信息无法确认 请电话咨询或者重新实名认证后再试
ALIPAY_NOT_PRIVATE_ACCOUNT 当前登录支付宝账户非个人账户 请更换支付宝账号重新登录后再试
ADMITTANCE_CHECK_FAILED 对方准入校验未通过 请等待对方授权后重试
QUERY_TIMES_LIMIT 规定时间内查询次数超过上限 请等待一定时间后重试
CERTNO_NAME_INCONFORMITY 证件信息有误 传入的证件信息与当前登录账户不匹配,请修改入参或更换当前登录支付宝账户后重试
USER_NOT_MATCH 支付宝账户id不匹配 传入的支付宝账户id与当前登录账户不匹配,请更换当前登录支付宝账户后重试
ARRANGEMENT_ERROR 无效的合约或合约状态异常 请在商户签约后重试
ILLEGAL_ARGUMENT 参数有误 请根据错误码描述修改入参后重试
onlineServer