更新记录:
2022-12-12:process_code 修改为必填项
2017-09-30:process_code枚举值增加02-关停商户
风险商户数据同步:
接口调用方式:商户调用支付宝API
API名称:alipay.security.risk.customerrisk.send
API应用场景说明:商户收到支付宝发送的商户风险交易推送后,调用该接口回传风险商户详细信息
请求地址:
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
公共请求参数:
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
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 | 商户请求参数的签名串,详见签名 | 详见示例 |
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 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
|
业务请求参数:
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
smid | String | 是 | 256 | 间连商户支付宝ID | 2088123412343480 |
risk_type | String | 是 | 256 | 商户风险类型: 01:赌博,02:欺诈,03:色情,04:套现,05:违禁;06:非法投融资;07:其他; 商户权益类型: 95:KA-综合评级类可信;96:KA-交易规模可信;97:KA-知名/连锁企业可信;98:KA-行业类可信;99:其他可信 准入权益类型: whitechains:可信连锁店;whiteWholesaler:可信批发商;whiteEducation:可信线上教育 |
02 |
risk_time | String | 是 | 1024 | 商户风险定性时间;格式:yyyy-mm-dd hh:mm:ss | 2020/3/2 0:00 |
process_code | String | 是 | 100 | 对商户的处理情况: 01:已延迟结算,02:关停商户,10:切换到普通费率通道,99:其他 多重处理结果可调用多次,每次回传一种处理结果 |
01 |
source | String | 是 | 100 | 01:支付宝,02:自识别,03:其他 | 01 |
cert_no | String | 是 | 128 | 商户的身份证号码 | 412829111111000000 |
bank_card_no | String | 是 | 128 | 商户的银行卡卡号 | 6228480402637870000 |
business_license_no | String | 是 | 128 | 商户的营业执照号码 | 440306123456776 |
mobile_no | String | 否 | 128 | 商户注册的手机号码 | 13810935692 |
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号 |
channel | String | 否 | 128 | 商户拓展的渠道标识 | |
extension_info | String | 是 | 1024 | 拓展字段,详细字段单独定义,见下方extension_info 字段说明 |
extension_info 字段说明(JSON格式)
字段英文名 | 字段类型 | 字段中文名 | 字段描述 |
merchant_name | string | 商户真实名称 | 示例值:一二三有限公司 |
mth_trade_cnt | int | 商户整体月交易量 | 商户在全渠道的交易量,示例值:100 |
mth_trade_amt | double | 商户整体月交易额 | 商户在全渠道的交易额,示例值:526.23 |
credit_card_cnt_prop | double | 商户整体信用卡交易量占比 | 商户在全渠道通过信用卡收款的交易量占比,示例值:0.23 |
credit_card_amt_prop | double | 商户整体信用卡交易额占比 | 商户在全渠道通过信用卡收款的交易额占比,示例值:0.31 |
mth_active_days | int | 月活跃天数 | 商户近一个月有交易的活跃天数,示例值:28 |
industry | string | 商户细分行业 | 示例值:留学教育机构、连锁火锅店 |
related_smid | string | 商户关联的主SMID | 该商户关联的主要收款SMID,示例值:2088123412341234 |
pos_id | string | 支付机具设备号 | 示例:CN123456789A |
响应参数:
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码 | 40004 |
msg | String | 是 | - | 网关返回码描述 | Business Failed |
sub_code | String | 否 | - | 业务返回码 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 |
错误码:
错误码 | 返回样例 | 原因 |
MISSING_REQUIRED_ARGUMENTS | {success=false, result=null, errorCode='MISSING_REQUIRED_ARGUMENTS', errorMessage='缺少必选参数'} | smid或process_code为空 |
INVALID_PARAMETER | {success=false, result=null, errorCode='INVALID_PARAMETER', errorMessage='参数不合法'} | process_code不是两位数字 |
正确返回样例 | {success=true, result={"success":"true"}, errorCode='null', errorMessage='null'} |
SDK调用样例&返回数据样例
调用样例:
返回数据样例:
{"body":"{\"alipay_security_risk_customerrisk_send_response\":{\"code\":\"10000\",\"msg\":\"Success\"},\"sign\":\"PK9mGX8uy3xfwRKygPxPCuf62YQU5JrdY4yDSn5dRhRcjtcTlzm8Gzv1yhnNXOhyITDzY6O8+rwPpSUqrQXT3VvS6dkMvEnoXsT5uKefRKX9PuvwbttN5Vc7Me57aPX9dReiBji4HgBVMI22gcugZ8mBTuNIecYNAAxiVcZjUFQ=\"}","code":"10000","errorCode":"10000","msg":"Success","params":{"biz_content":"{\"cert_no\":\"659004198009128344\",\"mobile\":\"1359892324\",\"smid\":\"123ssd\",\"external_id\":\"105290059990194\",\"process_code\":\"99\",\"business_license_no\":\"34xggdf345\" }"},"success":true}