商户健康分接口文档

更新时间：2020/07/03 访问次数：7552

1. 服务说明

1) 服务适用场景

商户健康分服务适用于具有商户管理需求，或提供商户增值服务的合作伙伴群体，旨在协助合作伙伴有效的识别商户质量，并对优质商户提供更多特权服务。

2) 服务调用方式

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

3) 服务申请前的准备工作

有效的APPID：您需提供一个有效的应用ID（APPID）来调用此服务，您可前往

https://openhome.alipay.com/platform/appManage.htm#/apps生成一个专属应用，

或使用现有的APPID来申请此服务。

2. 接口说明

1) 接口名称

alipay.security.risk.customerrisk.query

2) 参数说明

1、入参说明

smid(商户身份标识)必须正确填写；

cert_no、bank_card_no、business_license_no 三项均需准确填写，否则会影响返回结果准确性，如小微商户没有business_license_no，可填null。

2、返回参数说明

风险评级说明（riskinfo_indirect_mer_score ）：

评级结果	评级说明
rank0	无结果，smid有误，或不存在
rank1	商户健康度低
rank2	表示商户健康性中等
rank3	表示商户健康度；良好

3) 业务请求参数

参数	类型	是否必填	最大长度	描述	示例值
service	String	是	128	服务类型,请按照示例值填写	固定值indirect_mer_score
risk_type	String	是	1024	用于输入商户风险类型	固定值riskinfo_indirect_mer_score
smid	String	是	128	全称secondaryMerchantId，是指通过支付宝间连进件接口返回的商户唯一受理编号	2088501624560335
cert_no	String	是	128	用于传递需查询商户风险的身份证号码	412829111111000000
bank_card_no	String	是	128	用于传递需查询商户的银行卡卡号	6228480402637874213
business_license_no	String	是	128	用于传递需查询商户的营业执照号码	440306123456776
mobile_no	String	否	128	用于输入用户注册的手机号码。如果为空，请传”null”	13810935692
merchant_scene	String	是	128	风险咨询类型： 01：基础服务评级； 02：增值服务咨询；默认传01；如果疑问，可以对接的时候咨询技术支持或者运营同学	01；
store_mcc_desc	String	否	128	门店行业类目	餐饮
province_code	String	否		省编码；请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。（参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）	370000
city_code	String	否	128	城市编码；请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。（参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）	371000
district_code	String	否	128	区域编码；请按照https://gw.alipayobjects.com/os/basement_prod/253c4dcb-b8a4-4a1e-8be2-79e191a9b6db.xlsx 表格中内容填写。（参考资料： http://www.stats.gov.cn/tjsj/tjbz/tjyqhdmhcxhfdm/）	371002
outlet_address	String	否	128	门店地址；不需要传城市和行政区	万塘路18号
risk_label	String	否	128	01：赌博，02：欺诈，03：色情，04：套现，05：违禁；06：非法投融资；07：其他；95：KA-综合评级类可信；96：KA-交易规模可信；97：KA-知名/连锁企业可信；98：KA-行业类可信；99：其他可信	01

4) 公共请求参数

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.security.risk.customerrisk.query
format	String	否	40	仅支持JSON	JSON
charset	String	是	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	String	是	10	商户生成签名字符串所使用的签名算法类型，目前支持RSA/RSA2。推荐使用RSA2	RSA2
sign	String	是	256	商户请求参数的签名串，详见（https://docs.open.alipay.com/200/105351）	详见示例
timestamp	String	是	19	发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"	2014-07-24 03:07:50
version	String	是	3	调用的接口版本，固定为：1.0	1.0
notify_url	String	否	256	支付宝服务器主动通知商户服务器里指定的页面http/https路径。	http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token	String	否	40	详见应用授权概述（https://docs.open.alipay.com/common/105193）
biz_content	String	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

5) 业务返回参数

参数	类型	是否必填	最大长度	描述	示例值
risk_result	String	是	1024	风险分析结果，返回针对商户评级场景的等级值	{" riskinfo_indirect_mer_score ":"rank0"}
risk_result_desc	String	是	1024	风险结果分析返回值rank0,rank1,rank2,rank3

6) 公共返回参数

参数	类型	是否必须	最大长度	描述	示例值
code	String	是	～	网关返回码，详见文档 : https://docs.open.alipay.com/common/105806	40004
msg	String	是	～	网关返回码描述，详见文档 : https://docs.open.alipay.com/common/105806	Business Failed
sub_code	String	否	～	网关明细返回码，详见文档 : https://docs.open.alipay.com/common/105806	isv.invalid-signature
sub_msg	String	否	～	网关明细返回码描述，详见文档 : https://docs.open.alipay.com/common/105806	交易已被支付
sign	String	是	64	签名，详见文档 :hhttps://docs.open.alipay.com/common/105806

7) 代码样例

请求示例

{
"biz_content": {
"service": "indirect_mer_score",
"risk_type": "riskinfo_indirect_mer_score",
"smid": "2088031872450000",
"cert_no": "230106198601127876",
"business_license_no": "39284729387492232",
"bank_card_no": "6214867559610000",

"merchant_scene": "01",

"mobile_no": "null"
}
}

响应示例

{

"alipay_security_risk_customerrisk_query_response": {

"code": "10000",

"msg": "Success",

"risk_result_desc": "{\"rank0\":\"等级0\"}",

"risk_result": "{\" riskinfo_indirect_mer_score \":\"RANK3\",\" riskinfo_indirect_mer_score \": \"184\"}"

"sign": "c4TdBOxQIhYk3WEZuXYAcyarxjQoIXoyI2EGoJ8Ss1U/C/BdS4AaFd025NXlewatubYalad9vlRf69T8e6MnfDGlHydh85uXOUZLWLBEs2HMg8LsiVpWyK2vCLqNAIEBOrHYqeC0w+PuLOaB4Qcv7E36dS2aCitRaRDQboP/jD3UTwiUde0/tKdnySV8AO3SYuM+b6mVwEyY1I21rMTomQtXgWV5ASb9Z/F75Pu/YupdRN1JVEP6nRWgHnAXUVARMK7W167N0KvR17On7iejtkzbBaqdqSyk+WDBkWbOOKcOoI8se11ouU+C+5fkHXRz3YAJxEIahn2bYeNC04bX5A=="

}

8) 报错说明

错误码（errorMessage）	错误明细	解决方案
serviceNoAuth	服务未授权	请检查配置的账户是否已签约相应的功能包
riskTypeNoAuth	场景（risktype）未授权	请检查配置的账户是否已签约相应的功能包请检查risktype参数是否正确
bizContentEmpty	风险数据内容为空	检查入参数据格式
paramMissingError	参数缺失	检查必传参数是否传入
param error	参数错误	检查入参格式是否符合文档要求
SYSTEM_OUT_ERROR	系统繁忙	联系技术支持同学或者稍后再试
INVALID_PARAMETER	缺少必选参数或参数有误	检查参数是否正确或者缺失
OVER_LIMIT	超过调用量限制	如需增加额度，请发邮件至RiskGoCSC@service.alipay.com进行申请

3. 常见问题

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

开放平台

RiskGo安全合作平台文档