文档中心 > API类目 > 开放生态API

alipay.security.prod.fingerprint.riskcontrol.query (指纹风险机型查询)

控制黑名单设备不显示指纹入口,向服务端查询该设备指纹功能是否可用。

公共参数

请求地址:
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数:
参数 类型 是否必填 最大长度 描述 示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.security.prod.fingerprint.riskcontrol.query
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 - 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
auth_type String 必须 10 IFAA标准中的校验类型,目前1为指纹 1
build_model String 必须 64 buildModel,通过IFAA客户端SDK获取到的设备具体型号,android可通过设备厂商的公开API获取,iOS为设备的internalname,用于标示一台具体市场上的设备名称, iPhone7#2
aaid String 可选 32 aaid:指纹SDK获取到的aaid,与设备密钥一一对应,为IFAA定义的一个设备型号信息; IFAA-APPLE
device_id String 必须 100 设备ID,android为IFAA TA里定义,iOS为IFAA定义后存储在keyChain,接入方调用指纹客户端SDK获取,无需自己取值,用于用户绑定,区分单设备用户 FFFFFFFF9BA0A52078D94D44962D8CD675B7C223

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
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=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
check_result Boolean 必填 10 IFAA服务端查询结果,true为支持指纹功能,false为不支持 true

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipaySecurityProdFingerprintRiskcontrolQueryRequest request = new AlipaySecurityProdFingerprintRiskcontrolQueryRequest();
request.setBizContent("{" +
"\"auth_type\":\"1\"," +
"\"build_model\":\"iPhone7#2\"," +
"\"aaid\":\"IFAA-APPLE\"," +
"\"device_id\":\"FFFFFFFF9BA0A52078D94D44962D8CD675B7C223\"" +
"}");
AlipaySecurityProdFingerprintRiskcontrolQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_security_prod_fingerprint_riskcontrol_query_response":{
		"msg":"Success",
		"code":"10000",
		"check_result":true
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 检查参数是否符合IFAA协议标准
SYSTEM_ERROR 系统繁忙 系统暂时不可用,请稍后再试
IFAA_ERR_UNSUPPORT_DEVICE 设备不支持指纹功能(对设备进行黑名单控制) 关闭该设备的指纹入口,停止使用该设备的指纹校验功能

公共错误码

返回
顶部