淘宝开放平台

登录
文档中心 > API类目 > 芝麻信用API

芝麻信用API

zhima.merchant.creditlife.risk.apply (信用生活行业用户风险评估)

信用生活行业端外风险评估服务，根据合约控制集成协议授权、pass、isv等产品一起输出，降低行业商户的接入成本

公共参数

请求地址：
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数：
参数 类型 是否必填 最大长度 描述 示例值
app_id String 是 32 支付宝分配给开发者的应用ID 2014072300007148
method String 是 128 接口名称 zhima.merchant.creditlife.risk.apply
format String 否 40 仅支持JSON JSON
charset String 是 10 请求使用的编码格式，如utf-8,gbk,gb2312等 utf-8
sign_type String 是 10 商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2 RSA2
sign String 是 256 商户请求参数的签名串，详见签名 详见示例
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 必须 32 业务流水号，每一笔业务使用一个新的业务流水号，不能重复 24812155555
cert_no String 必须 32 证件号，一般为身份证号码 110101200112302357
address String 必须 128 地址 浙江省杭州市西湖区万塘路18号黄龙时代广场
mobile String 必须 32 手机联系方式 13800001234
name String 必须 64 姓名 张三
item_id String 必须 64 接入信用套餐所分配的产品码 2017102501000111123481626070

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String 是 - 网关返回码,详见文档 40004
msg String 是 - 网关返回码描述,详见文档 Business Failed
sub_code String 否 - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String 否 - 业务返回码描述,详见文档 交易已被支付
sign String 是 - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
open_id String 选填 64 用户在商端的身份标识，如果在接口的入参中存在该参数，芝麻网关会自动转化 无
zm_risk String 选填 16 风控结果 Y
zm_score String 选填 10 芝麻分 678
zm_grade String 必填 10 较差、中等、良好、优秀、极好5个级别 较差

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaMerchantCreditlifeRiskApplyRequest request = new ZhimaMerchantCreditlifeRiskApplyRequest();
request.setBizContent("{" +
"\"transaction_id\":\"24812155555\"," +
"\"cert_no\":\"110101200112302357\"," +
"\"address\":\"浙江省杭州市西湖区万塘路18号黄龙时代广场\"," +
"\"mobile\":\"13800001234\"," +
"\"name\":\"张三\"," +
"\"item_id\":\"2017102501000111123481626070\"" +
"}");
ZhimaMerchantCreditlifeRiskApplyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
{
    "zhima_merchant_creditlife_risk_apply_response":{
        "msg":"Success",
        "zm_score":"678",
        "code":"10000",
        "zm_risk":"Y",
        "open_id":"无",
        "zm_grade":"较差"
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "zhima_merchant_creditlife_risk_apply_response":{
        "msg":"Service Currently Unavailable",
        "code":"20000",
        "sub_msg":"系统繁忙",
        "sub_code":"isp.unknow-error"
    },
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码 错误描述 解决方案
ARRANGEMENT_NOT_EXISTS 商户未签约此产品 请去签约
INVALID_PARAMETER 参数有误参数有误参数为空 输入参数
TRANSACTION_ID_REPEAT 相同业务流水号但业务参数不一致，请求被拒绝 请每个请求生成唯一的业务流水号transaction_id
SYSTEM_ERROR 系统繁忙 稍后再试

公共错误码

公共错误码
有用(0)
我要提问
返回
顶部