zhima.credit.watchlist.brief.get(行业关注名单普惠版) 在线调试(沙箱环境)

用于商户准入判断, 无需授权,商户亦可用于参考用户风险等级

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.credit.watchlist.brief.get
format String 40 仅支持JSON JSON
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
transaction_id String 必选 64 商户请求的唯一标志,64位长度的字母数字下划线组合。该标识作为对账的关键信息,商户要保证其唯一性,对于用户使用相同transaction_id的查询,芝麻在一天(86400秒)内返回首次查询数据,超过有效期的查询即为无效并返回异常,有效期内的重复查询不重新计费 201512100936588040000000465158
product_code String 必选 20 产品码,直接使用[示例]给出的值 w1010100000000002977
cert_type String 必选 32 证件类型 目前支持三种IDENTITY_CARD(身份证),PASSPORT(护照),ALIPAY_USER_ID(支付宝uid) IDENTITY_CARD
cert_no String 必选 32 与参数cert_type对应,分别为:证件号完整值(例:420983190001010001) 或支付宝uid(例:2088102165398450) 420983190001010001
name String 特殊可选 64 用户姓名 当证件类型为ALIPAY_USER_ID时可以不填 张三

响应参数

参数 类型 是否必填 最大长度 描述 示例值
biz_no String 必填 32 唯一标示每一次接口调用 ZM201610263000000165700306914709
level String 必填 10 输入用户返回结果:
0 未命中逾期名单
1 命中一类名单,例如用户有一周以内的轻微逾期
2 命中二类名单,例如用户有一周以上中等逾期
3 命中三类名单,例如用户有一个月以上的严重逾期
N/A 无法评估该用户逾期状况,例如未获得用户授权。
0

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaCreditWatchlistBriefGetRequest request = new ZhimaCreditWatchlistBriefGetRequest();
request.setBizContent("{" +
"\"transaction_id\":\"201512100936588040000000465158\"," +
"\"product_code\":\"w1010100000000002977\"," +
"\"cert_type\":\"IDENTITY_CARD\"," +
"\"cert_no\":\"420983190001010001\"," +
"\"name\":\"张三\"" +
"  }");
ZhimaCreditWatchlistBriefGetResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_credit_watchlist_brief_get_response": {
        "code": "10000",
        "msg": "Success",
        "biz_no": "ZM201610263000000165700306914709",
        "level": "0"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
API_PRODUCT_NOT_MATCH 输入的产品码不正确 请传入正确的产品码w1010100000000002977
INVALID_TRANSACTION_ID 业务流水号不正确 传入正确的transaction_id字段。出现该错误是由于传入的业务流水号格式不正确,transaction_id格式要求:64位长度的字母数字下划线组合。该标识作为对账的关键信息,商户要保证其唯一性。 参数不同的请求需要生成唯一的业务流水号transaction_id进行调用
NO_VALID_ARRANGEMENT 无有效合约 产品未签约或合约到期 需要商户完成产品签约或续约
INVALID_PARAMETER 参数有误 检查传入的参数是否齐全和正确
TRANSACTION_ID_EXPIRED 业务流水号已过期 请传入正确的业务流水号。出现该错误是由于业务流水号过期导致。对于相同transaction_id的查询,芝麻在一天(86400秒)内返回首次查询数据,超过有效期的查询即为无效并返回异常,有效期内的重复查询不重新计费。请使用新的transaction_id进行查询
TRANSACTION_ID_REPEAT 相同业务流水号但业务参数不一致,请求被拒绝。 参数不同的请求需要生成唯一的业务流水号transaction_id进行调用
TRANSACTIONID_CLOSE 对应的流水超时关闭 对应的流水超时关闭 请使用新的transaction_id进行查询
PRODUCT_CODE_IS_NULL 产品码为空 请传入正确的产品码w1010100000000002977
SYSTEM_ERROR 系统繁忙 系统繁忙,可尝试重试
onlineServer