#
数美天网-交易风控版权所有 翻版必究
交易风控#
事件接口#
请求URL:#
集群 | URL | 支持产品列表 |
---|---|---|
北京 | http://api-skynet-bj.fengkongcloud.com/v4/event | 天网风险识别 |
美国(弗吉尼亚) | http://api-skynet-fjny.fengkongcloud.com/v4/event | 天网风险识别 |
新加坡 | http://api-skynet-xjp.fengkongcloud.com/v4/event | 天网风险识别 |
欧洲(法兰克福) | http://api-skynet-eur.fengkongcloud.com/v4/event | 天网风险识别 |
请求方法:#
POST
字符编码:#
UTF-8
建议超时时间:#
1s
请求参数:#
请求body = 通用请求参数 + 事件特有参数 (放在data字段下)
#
通用的请求参数放在HTTP Body中,采用Json格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
accessKey | string | 接口认证密钥 用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | 数美分配 |
appId | string | 应用ID,用于区分相同公司的不同应用 | 必传参数 | 该参数传递值可与数美协商。 当公司app存在多个马甲包,分下面两种情况: 1. 马甲包账号互通,不同马甲包数据传入不同的appId,tokenId保持一致 2. 马甲包账号独立,不同马甲包数据传入不同的appId,tokenId必须不同 |
eventId | string | 事件ID,用于标识事件类型。 | 必传参数 | 不同的事件对应不同的策略,不同的事件输入参数可能会有细微的差别,请对应按照各事件详细传参说明 |
data | json_object | 请求的数据内容,事件特有参数可以放入data下传入 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
tokenId | string | 用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值 | 必传参数 | 注意点: 1. tokenId传入业务系统中的用户ID,务必保证接入数美全部事件相同用户传入的用户ID值一致且唯一 2. 如果公司主体下存在多个应用且需要按应用区分账号,即相同用户ID在不同应用中代表不同用户。则建议在传入的用户ID之前拼接应用标识作为tokenId传入,达到区分账号体系的目的。 3. 如果没有区分需求,则直接将用户ID传入tokenId字段即可 4. 如果传入错误,会导致系统认为是不同账号,账号的行为无法关联,导致识别不准确 |
ip | string | 当前业务事件发生时的客户端公网ipv4地址 | 必传参数 | 非内网ip |
timestamp | int64 | 当前业务事件发生时的时间戳,单位为毫秒(ms) | 必传参数 | |
deviceId | string | 数美设备指纹标识,由数美SDK生成 | 强烈建议 | 数美设备指纹标识,用于用户行为分析。 注: 1. 接入数美SDK前的版本,无法获取到deviceId的情况下,deviceId传空“”即可; 2. 直接传输getDeviceId获取到的原始字段,不需要解密 |
os | string | 应用端操作系统类型 | 强烈建议 | 可选值:android、harmony、ios、weapp、web、aliapp:支付宝小程序、ttapp:抖音小程序、tmapp:天猫小程序 |
appVersion | string | 应用版本号 | 强烈建议 | 传入当前应用或服务正在使用的版本号,格式为3个点4段数字,每段数字最多4位,例如3.2.1.1234 。不足4段的请补0,例如2.1.5 传入2.1.5.0 。多于4段的取前4段,例如2.1.5.1.1 传入2.1.5.1 。 |
activityId | string | 营销活动id | 建议 | 建议传入对应营销活动标识id |
activityType | string | 活动类型,主要分为线下活动和线上活动。根据不同活动类型可以调用不同策略 | 建议 | 可选值:online_activity、offline_activity。online_activity为线上活动,如线上签到等;offline_activity为线下活动,如地推拉新活动等; |
userAgent | string | 用户代理 | 强烈建议 | |
phoneMd5 | string | 手机号的Md5,32位小写加密串 | 建议 | |
phoneSha256 | string | 手机号的Sha256加密串 | 建议 | |
newCountryCode | string | 手机号国家码 | 建议 | 该字符串规范为四位字符串,默认为中国手机号国家码0086,传入规范详见国家码与国家对应关系 |
role | string | 角色 | 强烈建议 | 可选值(强校验取值只能为空、ADMIN 、HOST );HOST 代表主播,针对主播,将会放开多开、PC模拟器规则以及关联频度策略阈值,以保证主播的正常体验和使用。 |
level | int | 用户等级,针对不同等级的用户可配置不同拦截策略 | 强烈建议 | 可选值:0,1,2,3,4 分别对应:0 :最低级用户,典型如新注册、完全不活跃或等级为0的用户等1 :较低级用户,典型如低活跃或低等级用户等2 :中等级用户,典型如具备一定活跃或等级中等的用户等3 :较高级用户,典型如高活跃或高等级用户等4:最高级用户,典型如付费用户、VIP用户、可考虑放过的用户等 |
vdata | json | 微行为数据传入字段 | 建议 | |
extra | json | 用户自定义数据 | 建议 | 如无必要,不传 |
passThrough | json | 用户自定义透传字段 | 建议 | 如无必要,不传 |
counterInfo | json_object | 事件关联柜台信息 | 可选参数 | 事件与柜台具有关联时,强烈建议接入,否则部分策略无法使用,详见counterInfo参数 |
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
counterName | string | 柜台名称 | 可选参数 | |
counterProvince | string | 柜台所在省份 | 可选参数 | |
counterCity | string | 柜台所在城市 | 可选参数 | |
counterId | string | 柜台唯一ID | 可选参数 | 注意点: 1. counterId传入业务系统中柜台ID,务必保证接入数美全部事件相同柜台传入的counterID值一致且唯一 2. 如果传入错误,会导致系统认为是不同柜台,导致识别不准确 |
counterDistrict | string | 柜台所在地区 | 可选参数 | |
counterAddress | string | 柜台详细地址 | 可选参数 |
返回结果#
放在HTTP Body中,采用Json格式,具体参数如下:
参数名称 | 类型 | 参数说明 | 是否必返 | 规范 |
---|---|---|---|---|
code | int | 返回码 | 是 | 1100 :成功1901 :QPS超限1902 :参数不合法1903 :服务失败1911 :图片下载失败9101 :无权限操作3000 :运营商错误除message和requestId之外的字段,只有当code为1100时才会存在 |
message | string | 返回码描述 | 是 | 和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作 |
requestId | string | 请求标识 | 是 | 请求唯一标识,用于排查问题和后续效果优化,强烈建议保存 |
riskLevel | string | 当前事件的处置建议 | 是 | PASS :通过REVIEW :审核REJECT :拒绝VERIFY :验证 |
detail | json_object | 风险详情信息,详情见下文 | 是 | 详见detail结果详情 |
tokenProfileLabels | json_array | 账号属性标签 | 否 | 仅在服务开通时返回,详见tokenProfileLabels结果详情 |
tokenRiskLabels | json_array | 账号风险标签 | 否 | 仅在服务开通时返回,详见tokenRiskLabels结果详情 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识,命中的最高优先级规则标识 | |
hits | Json array | 事件命中的所有规则标识 | hits中每个字段都是一个object,详见hits结果详情 |
ip_country | string | ip归属地国家 | |
ip_province | string | ip归属地省份 | |
ip_city | string | ip归属地城市 | |
verifyType | string | 当处置建议为VERIFY 时,返回verifyType | UPSMS :上行短信验证码DOWNSMS :下行短信验证码CAPTCHA :验证码(点选或滑动等)SEQUENCE :语序验证(点选或输入)SPATIAL :空间逻辑推理FACE :人脸检测DELAY :延时交易 |
machineAccountRisk | json | 账号历史打黑信息 | 只有当前账号历史被打入账号黑库后,账号的相关流水才会返回该结构体,详见machineAccountRisk结果详情 |
smid | string | 设备唯一标识 | 需要传入deviceId字段且联系数美开通配置后,才会返回该字段 |
matchedLists | json_arrar | 功能名单内容 | 详见matchedLists结果详情 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
name | string | 名单名称 | |
riskLevel | string | 处置建议 | |
words | json_array | 敏感词命中信息;该json_array下的每个item代表一个敏感词的一次命中 | 该名单下命中的敏感词风险详情,用于解释命中的敏感词位置等信息,详见words结果详情 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
word | string | 敏感词 | 组合词返回 “服务|社会”;返回的是添加名单时添加的敏感词内容 |
checkItem | string | 配置匹配字段 | 名单配置时的匹配字段 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
description | string | 当前事件的风险描述 | |
model | string | 规则标识 | |
riskLevel | string | 当前事件的处置建议 | PASS :通过REVIEW :审核REJECT :拒绝VERIFY :验证 |
verifyType | string | 当处置建议为VERIFY 时,返回verifyType | UPSMS :上行短信验证码DOWNSMS :下行短信验证码CAPTCHA :验证码(点选或滑动等)SEQUENCE :语序验证(点选或输入)SPATIAL :空间逻辑推理FACE :人脸检测DELAY :延时交易 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
tokenSampleLastTs | int64 | 最近打黑时间,毫秒级 | 如:"tokenSampleLastTs": 1683026613000 |
tokenSampleDesc | string | 历史打黑策略的description | 如:"tokenSampleDesc": "高风险设备:IP异常聚集" |
其中标签类返回字段
tokenProfileLabels详情的内容返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号属性标签的一级标签。 |
label2 | string | 二级标签 | 展示账号属性标签的二级标签。 |
label3 | string | 三级标签 | 展示账号属性标签的三级标签。 |
description | string | 风险描述 | 展示账号属性标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号风险标签的一级标签。 |
label2 | string | 二级标签 | 展示账号风险标签的二级标签。 |
label3 | string | 三级标签 | 展示账号风险标签的三级标签。 |
description | string | 风险描述 | 展示账号风险标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
事件列表#
事件 | eventId | 规范 |
---|---|---|
下虚拟商品订单 | virtualOrder | 参数详情 |
完成订单 | finishOrder | 参数详情 |
支付 | payment | 参数详情 |
绑卡 | addCard | 参数详情 |
交易结果 | notify | 参数详情 |
转账 | transfer | 参数详情 |
实名认证 | identityVerify | 参数详情 |
存入 | deposit | 参数详情 |
销户 | cancelAccount | 参数详情 |
应用内购买退款申请 | refundApplication | 参数详情 |
应用内购买退款成功 | refundSuccess | 参数详情 |
争议 | dispute | 参数详情 |
拒付 | chargeback | 参数详情 |
开户 | openAccount | 参数详情 |
事件详细API#
下虚拟商品订单 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
product | string | 虚拟商品名称 | 必传参数 | 例如:金币、道具、会员等机票(航班号+“-”+日期,CA288-20180101) |
orderId | string | 订单ID | 强烈建议 | 该商品订单唯一标识 |
interval | int64 | 商品发布到下单时间,单位毫秒(ms) | 强烈建议 | 主要用于商品秒杀 |
price | float64 | 下单总金额(优惠前) | 强烈建议 | 货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69 |
discount | float64 | 该订单享受的优惠金额 | 强烈建议 | 商品订单原价–商品订单实际支付的价格 |
account | float64 | 购买商品后账户余额 | 强烈建议 | 购买金币、Q币等虚拟商品后账户余额(增加),单位:元,例如:10.5 |
groupId | string | 拼团的团ID | 建议 | 用户自定义唯一标识 |
discountType | string | 优惠来源 | 建议 | 可选值:NEW_USER :新用户优惠REWARD_TASK :奖励任务优惠PURCHASE :购买 |
currency | string | 货币 | 强烈建议 | 参考货币代码表(ISO4217) |
orderSource | string | 订单来源的枚举值,分为两类: 1、用户购买官方的虚拟商品/充值; 2、用户间的虚拟商品交易,如游戏道具、NFT藏品等 | 建议 | 枚举值: mall: 订单来自官方商城,用来记录用户平台商城购买虚拟商品或充值; exchange: 订单来自玩家交易所,用来记录用户间的虚拟商品交易 |
完成订单 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
orderType | string | 订单类型 | 必传参数 | 可选值:offline:线下订单online:线上订单 |
orderId | string | 订单ID | 强烈建议 | 该商品订单唯一标识 |
paymentOpenId | string | 支付账户的唯一标识 | 强烈建议 | |
paymentAccountType | string | 支付账户类型,银行卡/微信/支付宝 | 强烈建议 | 可选值:bank :银行卡weixin :微信alipay :支付宝others :自由支付渠道 |
voucherTimestamp | int64 | 付款凭证上的付款时间戳 | 强烈建议 | |
orderResult | int | 订单成功或失败(例如订单超时未支付;如果是订单取消则不要调用此接口) | 强烈建议 | 可选值:1 :失败;0 :成功 |
nickName | string | 用户账户昵称 | 建议 | |
visitSubType | string | 扫描枪的类型 | 必传参数 | 传入扫描枪的类型,例如:CPC、IBM、SELF_CHECKOUT |
products | Json_array | 订单商品信息,详情见下文 | 必传参数 | |
paymentId | string | 付款 ID | 强烈建议 | 用户进行一次下单付款动作的标识;该标识标记了用户发起的一次下单付款行为。 |
price | float64 | 下单优惠前的金额 | 建议 | 货币计量单位为中国大陆法定货币人民币(CNY),单位:元例如:88.69 |
discount | float64 | 该订单享受的优惠金额 | 建议 | 商品订单原价 – 商品订单实际支付的价格 |
discountType | string | 优惠来源 | 建议 | 可选值:NEW_USER :新用户优惠REWARD_TASK :奖励任务优惠PURCHASE :购买 |
shopId | string | 门店编号 | 建议 | |
shopCountry | string | 门店归属国家 | 建议 | 用于社区团购场景若不存在传国家英文全称,如:CN |
shopProvince | string | 门店归属省 | 建议 | 中文如:山东省 |
shopCity | string | 门店归属市 | 建议 | 中文如:北京市 |
shopDistrict | string | 门店归属区 | 建议 | 中文如:朝阳区 |
shopAddress | string | 门店详细地址 | 建议 |
products 的内容如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
productId | string | 商品 ID,SPU 标准化产品单元 | 必传参数 | |
productCount | int | 商品数量 | 必传参数 | |
productType | string | 商品类型 建议用于需要特殊处理的商品, | 必传参数 | 根据需要传入即可,具体值可参考为:“贵金属” |
merchantId | string | 商户 ID | 必传参数 | 若无法区分第三方(自营) 传特定值“自营” |
productBrand | string | 商品品牌 | 强烈建议 | productBrand |
productName | string | 商品名称 | 强烈建议 | productName |
productPrice | float | 商品价格 | 强烈建议 | productPrice |
支付 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
method | string | 支付方式 | 强烈建议 | 可选值:qrscan :二维码支付,主动扫码qrshow :二维码支付,被动扫码(展示付款码给别人)phone :手机Pay支付widget :控件支付wechatQr : 微信扫码支付aliPay : 支付宝扫码/登录付款debitCard :借记卡支付creditCard :信用卡支付huaweiPay :华为钱包支付 |
amount | double | 支付金额 | 强烈建议 | |
currency | string | 计价货币 | 强烈建议 | 参考货币代码表(ISO4217) |
channel | string | 支付渠道 | 强烈建议 | |
cvvResultCode | string | cvv验证结果 | 强烈建议 | 参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm |
avsResultCode | string | 地址验证结果 | 强烈建议 | 参考http://www.emsecommerce.net/avs_cvv2_response_codes.htm |
cardBin | string | 卡bin,银行卡前六位 | 强烈建议 | |
bankCard | string | 支付银行卡号 | 强烈建议 | 当支付方式为借记卡支付或信用卡支付时传入该字段 XXXX-XXXX-XXXX-4242, 除后四位外,其余可用X代替 |
orderId | string | 订单编号 | 强烈建议 | 当前支付的订单编号 |
bankCardPhone | string | 银行卡绑定的手机号 | 强烈建议 | 当支付方式为借记卡支付或信用卡支付时传入该字段 |
prcid | string | 银行卡所属人身份证号码的MD5 | 强烈建议 | |
merchantType | string | 收款商户类型 | 强烈建议 | 可选值为:1 . normal: “普通商户”,商户资质要求较高,商户需要三证一表注册入网;2 . micro:“小微商户”,商户不需要提供三证一表,提供普通身份信息注册商户;3 . individual:“个人转账”,对收款方没有任何限制4 . platform:“平台自身” |
绑卡 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
simVrfyRst | string | 本机号校验结果 | 必传参数 | 取值:0 : 不一致;1 : 一致2 : 本机号校验开关关闭 3 : Token未取到 4 : 设备指纹超时 5 : 该用户手机号无法验证,包含境外手机号或取不到手机号的情况。若设备指纹后台本机号校验并落地接口中respCD返回其他非0000的应答码,直接通过此字段透传给数美 |
bankCard | string | 银行卡号 | 必传参数 | |
bankCardPhone | string | 银行卡绑定的手机号 | 必传参数 | |
simType | string | sim卡所属运营商 | 强烈建议 | 0 -移动;1 -电信 2 -联通当tokenStatus为000000时,type字段取值在上述0、1、2之间,其他情况type只能取9 |
deviceFP | string | 设备指纹id | 建议 | 该字段由客户自行采集,用于跨数据源的数据关联等 |
cardType | string | 银行卡类型 | 强烈建议 | 可选值:debit:借记卡credit:信用卡(贷记卡)combine:借贷合一semicredit:准贷记卡prepaid:预付卡 |
accountType | string | 账户类型 | 强烈建议 | 可选值:I :一类户,II :二类户;III :三类户 |
pidType | string | 银行卡所属人证件类型 | 必传参数 | 可选值:prc :身份证milc :军官证passport :护照hrc :回乡证mtp :台胞证polc :警官证solc :士兵证other :其它(境外) |
pid | string | 银行卡所属人证件号码 | 必传参数 | |
valid | int | 四要素、公安部等标准验证是否都成功。 | 必传参数 | 可选值:1 :成功0 :失败,任意标准验证失败 |
elemsValid | int | 四/五要素验证是否成功。有4/5要素验证时传入,没有不传。 | 强烈建议 | 可选值:1 :成功0 :失败 |
smsValid | int | 银行预留手机号短信验证是否成功。有预留手机号短信验证时传入,没有时不传。 | 强烈建议 | 可选值:1 :成功;0 :失败 |
prcidValid | int | 公安部验证是否成功。有公安部验证时传入,没有时不传 | 强烈建议 | 可选址:1 :成功0 :失败 |
countryCoderes | string | 预留手机号区号 | 强烈建议 | 传入当前绑卡交易的预留手机号区号 |
交易结果 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
notifyResult | int | 交易结果 | 必传参数 | 可选值:1 :成功0 :失败 |
notifyEvent | string | 被返回交易结果的事件 | 必传参数 | 可选值(被返回交易结果事件的eventId):transferpayment |
triggerReqId | string | 触发当前事件的事件流水号。 | 必传参数 | 即,被返回交易结果的事件流水号 |
Issuer | string | 返回机构(发卡行) | 强烈建议 | 取不到时传入空字符串。(注意,不是空白字符,而是长度为0的字符串) |
IssuerId | string | 返回机构代码(发卡行代码) | 强烈建议 |
转账 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
notifyResult | int | 交易结果 | 必传参数 | 可选值:1 :成功0 :失败 |
notifyEvent | string | 被返回交易结果的事件 | 必传参数 | 可选值(被返回交易结果事件的eventId):transferpayment |
triggerReqId | string | 触发当前事件的事件流水号。 | 必传参数 | 即,被返回交易结果的事件流水号 |
Issuer | string | 返回机构(发卡行) | 强烈建议 | 取不到时传入空字符串。(注意,不是空白字符,而是长度为0的字符串) |
IssuerId | string | 返回机构代码(发卡行代码) | 强烈建议 |
实名认证 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
simType | string | sim卡所属运营商 | 强烈建议 | 0 -移动;1 -电信 2 -联通当tokenStatus为000000时,type字段取值在上述0、1、2之间,其他情况type只能取9 |
openId | string | 微信openId,APP端:为空 | 强烈建议 | 没有可不传 |
faceCertNum | Int | 人脸识别次数,如果没有人脸识别则传为-1 | 强烈建议 | |
faceCertDuration | Int | 操作人脸视频录制时长,如果没有人脸视频录制则传为-1 | 强烈建议 | |
age | Int | 身份证年龄 | 强烈建议 | |
prcidAddress | string | 身份证地址 | 强烈建议 | |
prcidCountry | string | 身份证归属国家 | 强烈建议 | |
prcidProvince | string | 身份证归属省份 | 强烈建议 | 若无法解析,可不传 |
prcidCity | string | 身份证归属城市 | 强烈建议 | 若无法解析,可不传 |
bankCard | string | 银行卡卡号 | 强烈建议 | 不加密 |
bankCardPhone | string | 银行卡预留手机号 | 强烈建议 | |
birthday | string | 出生日期 | 强烈建议 | |
nameOCR | string | OCR识别的身份证姓名 | 强烈建议 | |
prcidOCR | string | OCR识别的申请人身份证号 | 强烈建议 | |
prcidValidTimestampStartOCR | string | ocr身份证生效日期 | 强烈建议 | |
prcidValidTimestampEndOCR | string | ocr身份证到期日期 | 强烈建议 | |
prcidIssuingOrg | string | 签发机关 | 强烈建议 | |
smsValid | int | 短信动态验证码验证结果 | 强烈建议 | 1 .有短信验证时传入;2 :无短信验证时不传;可选值:1 :成功0 :失败 |
faceValid | Int | 人脸识别验证结果 | 1 :有人脸验证时传入2 :无人脸验证时不传 | 可选值:1 :成功0 :失败 |
存入 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
prodType | string | 产品编号 | 必传参数 | 产品编号,互金产品信息查询接口返回 |
buyBaseAcctNo | string | 购买账号 | 必传参数 | |
tranAmt | double | 购买金额 | 必传参数 | 单位:元 |
payCode | string | 支付方式(只有W) | 必传参数 | S凭印鉴支取 P凭密码支取 W无密码无印鉴支取 B凭印鉴和密码支取 O凭证件支取 |
realRate | double | 执行利率 | 强烈建议 | |
couponCode | string | 单卡券码 | 强烈建议 | 使用卡券是需要输入卡券号码 |
acctExec | string | 推荐人 | 强烈建议 | |
tranDate | string | 交易日期 | 必传参数 | ESB接口字段,格式为YYYYMMDD |
tranTimestamp | string | 交易时间 | 必传参数 | ESB接口字段,格式为HHMMSSNNN |
sourceType | string | 渠道类型 | 必传参数 | ESB接口字段,各系统提供渠道类型说明 |
seqNo | string | 渠道流水号 | 必传参数 | ESB接口字段 |
systemId | string | 上游系统标识 | 强烈建议 | ESB接口字段 |
partnerId | string | 合作方标识 | 强烈建议 | ESB接口字段 |
logId | string | 全局流水号 | 强烈建议 | ESB接口字段 |
transNo | string | 交易流水码 | 必传参数 | |
transIo | string | 转入/转出 | 必传参数 | I转入O转出 |
payerNm | string | 付款方姓名或名称 | 强烈建议 | |
payerAccNo | string | 付款方账号 | 强烈建议 | |
payerBankNo | string | 付款方开户行行号 | 强烈建议 | |
payerBankNm | string | 付款方开户行行名 | 强烈建议 | |
payeeNm | string | 收款方姓名或名称 | 强烈建议 | |
payeeAccNo | string | 收款方账号 | 强烈建议 | |
payeeBankNo | string | 收款方开户行行号 | 强烈建议 | |
payeeBankNm | string | 收款方开户行行名 | 强烈建议 |
销户 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
baseAcctNo | string | 账号/卡号 | 必传参数 | |
othBaseAcctNo | string | 提现账号/卡号 | 必传参数 | |
ccy | string | 预授权币种 | 必传参数 | |
tranDate | string | 交易日期 | 必传参数 | ESB接口字段,格式为YYYYMMDD |
tranTimestamp | string | 交易时间 | 必传参数 | ESB接口字段,格式为HHMMSSNNN |
sourceType | string | 渠道类型 | 必传参数 | ESB接口字段,各系统提供渠道类型说明,渠道表见下表 |
seqNo | string | 渠道流水号 | 必传参数 | ESB接口字段 |
systemId | string | 上游系统标识 | 强烈建议 | ESB接口字段 |
partnerId | string | 合作方标识 | 强烈建议 | ESB接口字段 |
logId | string | 全局流水号 | 强烈建议 | ESB接口字段 |
accNo | string | 账号 | 强烈建议 | 反洗钱黑名单接口字段 |
custNo | string | 客户号 | 强烈建议 | 反洗钱黑名单接口字段 |
gender | string | 性别 | 强烈建议 | 反洗钱黑名单接口字段M男F女N不填 |
应用内购买退款申请 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
orderId | string | 退款订单号 | 必传 | 同下订单/下虚拟商品订单事件中的orderId |
applicationReason | int | 退款原因 | 强烈建议 | 可选值:1 :未到账2 :未成年人购买3 :家庭成员误购4 :功能不符合预期5 :意外点击购买6 :不想要了7 :其他 |
applicationTime | int64 | 申请退款时间,单位毫秒(ms) | 必传 |
应用内购买退款成功 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
orderId | string | 退款订单号 | 必传 | 同下订单/下虚拟商品订单事件中的orderId |
refundTime | int64 | 退款成功时间,单位毫秒(ms) | 必传 | |
applicationReason | int | 退款原因 | 强烈建议 | 可选值:1 :未到账2 :未成年人购买3 :家庭成员误购4 :功能不符合预期5 :意外点击购买6 :不想要了7 :其他 |
争议 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
orderId | string | 订单ID | 必传 | |
result | string | 争议结果 | 必传 | 可选值:won 成功lost 失败 |
disputeTime | int64 | 争议发送的时间 | 必传 | |
disputeType | string | 争议类型 | 必传 | 可选值:first_dispute second_dispute arbitrary_court |
拒付 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 | |||
chargebackTime | int64 | 发起拒付的事件戳,毫秒 | 必传 | |
chargebackCurrency | string | 拒付货币单位 | ||
chargebackAmount | float | 拒付金额 | ||
reasonCode | string | 拒付原因码 | ||
type | string | 类型 | 可选值:NoF : Notification of fraud, 卡组织的欺诈提醒,还未发生cbRFI : requirement for information, 还未发生cb,需要跟多的信息,需要及时回应NoC :notification of chargeback,cb已经发起 | |
gateway | string | 支付网关 | ||
reasonDescription | string | 拒付原因描述 | ||
cardCompany | string | 信用卡卡组织 | VISA, Mastercard, AMEX, JCB,Discovery, UnionPay | |
issuer | string | 发卡行 | ||
respondDeadline | int64 | 响应拒付的最后期限 | ||
fee | float | 拒付产生的费用 | 可选 | |
feeCurrency | string | 拒付费用计费货币 | 可选 |
开户 #
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
基础参数 | 需要满足基础参数的配置要求 |
示例:#
请求示例:#
同步返回示例:#
账号查询接口#
请求URL:#
集群 | URL | 支持产品列表 |
---|---|---|
北京集群 | http://api-tianxiang-bj.fengkongcloud.com/tianxiang/v4 | 风险查询 |
新加坡集群 | http://api-tianxiang-xjp.fengkongcloud.com/tianxiang/v4 | 风险查询 |
法兰克福集群 | http://api-tianxiang-eur.fengkongcloud.com/tianxiang/v4 | 风险查询 |
弗吉尼亚集群 | http://api-tianxiang-fjny.fengkongcloud.com/tianxiang/v4 | 风险查询 |
请求方法:#
POST
字符编码:#
UTF-8
建议超时时间:#
1s
请求参数:#
放在HTTP Body中,采用Json格式,具体参数如下:
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
accessKey | string | 接口认证密钥 用于权限认证,开通账号服务时由数美提供或使用开通邮箱登录数美后台右上角相关文档处查看 | 必传参数 | 数美分配 |
data | json_object | 请求的数据内容 | 必传参数 | 请求的数据内容,最长10MB,详见data参数 |
请求参数名 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
tokenId | string | 用户账号标识,建议使用贵司用户UID(可加密)自行生成 , 标识用户唯一身份用作灌水和广告等行为维度风控。如无用户uid的场景建议使用唯一的数据标识传值 | 不能为空 | 该ID为用户的唯一标识,且与其它数美接口的tokenId保持一致 |
返回结果#
放在HTTP Body中,采用Json格式,具体参数如下:
参数名称 | 参数类型 | 参数说明 | 是否必返 | 规范 |
---|---|---|---|---|
code | int | 返回码 | 是 | 1100 :成功1901 :QPS超限1902 :参数不合法1903 :服务失败1911 :图片下载失败9101 :无权限操作3000 :运营商错误除message和requestId之外的字段,只有当code为1100时才会存在 |
message | string | 返回码描述 | 是 | 和code对应:成功 QPS超限 参数不合法 服务失败 余额不足 无权限操作 |
requestId | string | 请求标识 | 是 | 请求唯一标识,用于排查问题和后续效果优化,强烈建议保存 |
tokenLabels | json_object | 账号标签信息 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
tokenProfileLabels | json_array | 账号属性标签 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
tokenRiskLabels | json_array | 账号风险标签 | 否 | 见下面详情内容,仅在tokenId传入且服务开通时返回 |
其中
1)tokenLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
machine_account_risk | json_object | 机器控制相关风险 | |
UGC_account_risk | json_object | UGC内容相关风险 | |
scene_account_risk | json_object | 场景账号风险 | 特殊场景才可取到,如航司等 |
machine_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
b_machine_control_tokenid | int | 机器账号 | 0 :非机器控制账号1 :机器控制账号 |
b_machine_control_tokenid_last_ts | int | 机器账号时间 | |
b_offer_wall_tokenid | int | 积分墙账号 | 0 :非积分墙账号1 :积分墙账号 |
b_offer_wall_tokenid_last_ts | int | 积分墙账号时间 |
UGC_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
b_politics_risk_tokenid | int | 涉政风险 | 0 :暂未发现涉政风险1 :存在涉政风险 |
b_politics_risk_tokenid_last_ts | int | 涉政风险时间 | |
b_sexy_risk_tokenid | int | 色情风险 | 0 :暂未发现色情风险1 :存在色情风险 |
b_sexy_risk_tokenid_last_ts | int | 色情风险时间 | |
b_advertise_risk_tokenid | int | 广告风险 | 0 :暂未发现广告风险1 :存在广告风险 |
b_advertise_risk_tokenid_last_ts | int | 广告风险时间 |
scene_account_risk的详情内容如下:
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
i_tout_risk_tokenid | int | 航司占座账号 | 0 :非航司占座账号1 :航司占座账号 |
i_tout_risk_tokenid_last_ts | int | 航司占座时间 |
其中标签类返回字段
1)tokenProfileLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号属性标签的一级标签。 |
label2 | string | 二级标签 | 展示账号属性标签的二级标签。 |
label3 | string | 三级标签 | 展示账号属性标签的三级标签。 |
description | string | 风险描述 | 展示账号属性标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
2)tokenRiskLabels的详情内容
返回结果参数名 | 参数类型 | 参数说明 | 规范 |
---|---|---|---|
label1 | string | 一级标签 | 展示账号风险标签的一级标签。 |
label2 | string | 二级标签 | 展示账号风险标签的二级标签。 |
label3 | string | 三级标签 | 展示账号风险标签的三级标签。 |
description | string | 风险描述 | 展示账号风险标签的中文描述。 |
timestamp | int64 | 最近一次命中策略的时间 | 最近一次命中策略的时间 |
detail | json_object | 证据描述 | 证据细节 |
示例:#
请求示例:#
同步返回示例:#
加密传输#
在某些场景下,为保障数据安全,我们需要对请求体进行加密处理后再进行传输。若需开通加密传输方式,请联系数美科技客服人员。本节将详细介绍如何实现这一过程,重点聚焦于使用SM4国密算法进行加密的实践方法。
#
支持的加密方式目前系统支持的加密传输方式主要为:
- SM4国密算法:适用于对安全性有较高要求的场景,符合国家密码管理局的相关标准。
#
配置与准备- 密钥管理:确保加密前,已根据规定配置好加密所需的密钥及组织唯一标识。这些密钥信息由系统管理员提供。
- 服务端配置:加密传输功能需预先在服务器端设置并上线。包括了密钥配置、组织唯一标识。
#
加密传输参数说明当决定采用加密传输时,请求中需包含特定参数以指示加密方式及加密内容,具体如下:
参数名称 | 类型 | 参数说明 | 是否必传 | 规范 |
---|---|---|---|---|
encryptType | string | 指定使用的加密方式。 | 加密传输时必须提供;非加密传输可忽略。 | 固定值 SM4 表示使用SM4国密算法进行加密。 |
encryptData | string | 经过加密处理后的数据字符串。 | 与 encryptType 相关联,加密传输时必填;否则无需提供。 | 使用指定的加密算法(如SM4)对原始请求数据进行加密后得到的结果。 |
#
示例请求体结构一个采用SM4加密的数据传输请求实例,其请求体可能如下所示(仅展示加密相关参数):
注意:
在SM4加密的数据传输请求中,请求体要求加密内容为JSON格式字符串,例如:{\"field1\":\"敏感数据1\",\"field2\":\"敏感数据2\",\"field3\":\"敏感数据3\"}
,确保信息安全加密处理。
#
示例返回体结构通过遵循上述指南,您可以确保敏感数据在传输过程中得到有效的保护,满足组织的安全合规要求。
附录: 国家码与国家对应关系表#
国家码(newCountryCode) | 国家(intl_phone_country) | 国家码(newCountryCode) | 国家(intl_phone_country) |
---|---|---|---|
0001 | ['美国', '加拿大'] | 0372 | ['爱沙尼亚'] |
0007 | ['俄罗斯', '哈萨克斯坦'] | 0373 | ['摩尔多瓦'] |
0020 | ['埃及'] | 0374 | ['亚美尼亚'] |
0027 | ['南非'] | 0375 | ['白俄罗斯'] |
0030 | ['希腊'] | 0376 | ['安道尔'] |
0031 | ['荷兰'] | 0377 | ['摩纳哥'] |
0032 | ['比利时'] | 0378 | ['圣马力诺'] |
0033 | ['法国'] | 0379 | ['梵蒂冈'] |
0034 | ['西班牙'] | 0380 | ['乌克兰'] |
0036 | ['匈牙利'] | 0381 | ['塞尔维亚'] |
0039 | ['意大利'] | 0382 | ['黑山'] |
0040 | ['罗马尼亚'] | 0383 | ['科索沃'] |
0041 | ['瑞士'] | 0385 | ['克罗地亚'] |
0043 | ['奥地利'] | 0386 | ['斯洛文尼亚'] |
0044 | ['英国', '泽西岛', '马恩岛', '根西岛'] | 0387 | ['波黑'] |
0045 | ['丹麦'] | 0389 | ['北马其顿'] |
0046 | ['瑞典'] | 0420 | ['捷克'] |
0047 | ['挪威', '斯瓦尔巴岛和扬马延岛'] | 0421 | ['斯洛伐克'] |
0048 | ['波兰'] | 0423 | ['列支敦士登'] |
0049 | ['德国'] | 0500 | ['福克兰群岛', '南乔治亚岛和南桑威奇群岛'] |
0051 | ['秘鲁'] | 0501 | ['伯利兹'] |
0052 | ['墨西哥'] | 0502 | ['危地马拉'] |
0053 | ['古巴'] | 0503 | ['萨尔瓦多'] |
0054 | ['阿根廷'] | 0504 | ['洪都拉斯'] |
0055 | ['巴西'] | 0505 | ['尼加拉瓜'] |
0056 | ['智利'] | 0506 | ['哥斯达黎加'] |
0057 | ['哥伦比亚'] | 0507 | ['巴拿马'] |
0058 | ['委内瑞拉'] | 0508 | ['圣皮埃尔和密克隆'] |
0060 | ['马来西亚'] | 0509 | ['海地'] |
0061 | ['澳大利亚', '赫德岛和麦克唐纳岛'] | 0590 | ['瓜德罗普', '圣巴泰勒米', '法属圣马丁'] |
0062 | ['印尼', '印度尼西亚'] | 0591 | ['玻利维亚'] |
0063 | ['菲律宾'] | 0592 | ['圭亚那'] |
0064 | ['新西兰'] | 0593 | ['厄瓜多尔'] |
0065 | ['新加坡'] | 0594 | ['法属圭亚那'] |
0066 | ['泰国'] | 0595 | ['巴拉圭'] |
0081 | ['日本'] | 0596 | ['马提尼克'] |
0082 | ['韩国'] | 0597 | ['苏里南'] |
0084 | ['越南'] | 0598 | ['乌拉圭'] |
0086 | ['中国'] | 0599 | ['库拉索', '荷兰加勒比区', '荷属安的列斯'] |
0090 | ['土耳其'] | 0649 | ['皮特凯恩'] |
0091 | ['印度'] | 0670 | ['东帝汶'] |
0092 | ['巴基斯坦'] | 0673 | ['文莱'] |
0093 | ['阿富汗'] | 0674 | ['瑙鲁'] |
0094 | ['斯里兰卡'] | 0675 | ['巴布亚新几内亚'] |
0095 | ['缅甸'] | 0676 | ['汤加'] |
0098 | ['伊朗'] | 0677 | ['所罗门群岛'] |
0210 | ['西撒哈拉'] | 0678 | ['瓦努阿图'] |
0211 | ['南苏丹'] | 0679 | ['斐济'] |
0212 | ['摩洛哥'] | 0680 | ['帕劳'] |
0213 | ['阿尔及利亚'] | 0682 | ['库克群岛'] |
0216 | ['突尼斯'] | 0683 | ['纽埃'] |
0218 | ['利比亚'] | 0685 | ['萨摩亚'] |
0220 | ['冈比亚'] | 0686 | ['基里巴斯'] |
0221 | ['塞内加尔'] | 0687 | ['新喀里多尼亚'] |
0222 | ['毛里塔尼亚'] | 0688 | ['图瓦卢'] |
0223 | ['马里'] | 0689 | ['法属波利尼西亚', '法属南部领地'] |
0224 | ['几内亚'] | 0690 | ['托克劳'] |
0225 | ['科特迪瓦'] | 0691 | ['密克罗尼西亚联邦'] |
0226 | ['布基纳法索'] | 0692 | ['马绍尔群岛'] |
0227 | ['尼日尔'] | 0850 | ['朝鲜'] |
0228 | ['多哥'] | 0852 | ['中国'] |
0229 | ['贝宁'] | 0853 | ['中国'] |
0230 | ['毛里求斯'] | 0855 | ['柬埔寨'] |
0231 | ['利比里亚'] | 0856 | ['老挝'] |
0232 | ['塞拉利昂'] | 0880 | ['孟加拉国', '孟加拉'] |
0233 | ['加纳'] | 0886 | ['中国'] |
0234 | ['尼日利亚'] | 0960 | ['马尔代夫'] |
0235 | ['乍得'] | 0961 | ['黎巴嫩'] |
0236 | ['中非'] | 0962 | ['约旦'] |
0237 | ['喀麦隆'] | 0963 | ['叙利亚'] |
0238 | ['佛得角'] | 0964 | ['伊拉克'] |
0239 | ['圣多美和普林西比'] | 0965 | ['科威特'] |
0240 | ['赤道几内亚'] | 0966 | ['沙特阿拉伯'] |
0241 | ['加蓬'] | 0967 | ['也门'] |
0242 | ['刚果共和国', '刚果布'] | 0968 | ['阿曼'] |
0243 | ['刚果民主共和国', '刚果金'] | 0970 | ['巴勒斯坦'] |
0244 | ['安哥拉'] | 0971 | ['阿联酋'] |
0245 | ['几内亚比绍'] | 0972 | ['以色列'] |
0246 | ['英属印度洋领地'] | 0973 | ['巴林'] |
0248 | ['塞舌尔'] | 0974 | ['卡塔尔'] |
0249 | ['苏丹'] | 0975 | ['不丹'] |
0250 | ['卢旺达'] | 0976 | ['蒙古'] |
0251 | ['埃塞俄比亚'] | 0977 | ['尼泊尔'] |
0252 | ['索马里'] | 0992 | ['塔吉克斯坦'] |
0253 | ['吉布提'] | 0993 | ['土库曼斯坦'] |
0254 | ['肯尼亚'] | 0994 | ['阿塞拜疆'] |
0255 | ['坦桑尼亚'] | 0995 | ['格鲁吉亚'] |
0256 | ['乌干达'] | 0996 | ['吉尔吉斯斯坦'] |
0257 | ['布隆迪'] | 0998 | ['乌兹别克斯坦'] |
0258 | ['莫桑比克'] | 1242 | ['巴哈马'] |
0260 | ['赞比亚'] | 1246 | ['巴巴多斯'] |
0261 | ['马达加斯加'] | 1264 | ['安圭拉'] |
0262 | ['留尼汪'] | 1268 | ['安提瓜和巴布达'] |
0263 | ['津巴布韦'] | 1284 | ['英属维尔京群岛'] |
0264 | ['纳米比亚'] | 1340 | ['美属维尔京群岛'] |
0265 | ['马拉维'] | 1345 | ['开曼群岛'] |
0266 | ['莱索托'] | 1441 | ['百慕大'] |
0267 | ['博茨瓦纳'] | 1473 | ['格林纳达'] |
0268 | ['斯威士兰'] | 1649 | ['特克斯和凯科斯群岛'] |
0269 | ['马约特', '科摩罗'] | 1664 | ['蒙塞拉特岛'] |
0290 | ['圣赫勒拿'] | 1670 | ['北马里亚纳群岛'] |
0291 | ['厄立特里亚'] | 1671 | ['关岛'] |
0297 | ['阿鲁巴'] | 1681 | ['瓦利斯和富图纳'] |
0298 | ['法罗群岛'] | 1684 | ['美属萨摩亚'] |
0299 | ['格陵兰'] | 1721 | ['荷属圣马丁'] |
0350 | ['直布罗陀'] | 1758 | ['圣卢西亚'] |
0351 | ['葡萄牙'] | 1767 | ['多米尼克'] |
0352 | ['卢森堡'] | 1784 | ['圣文森特和格林纳丁斯'] |
0353 | ['爱尔兰'] | 1787 | ['波多黎各'] |
0354 | ['冰岛'] | 1809 | ['多米尼加'] |
0355 | ['阿尔巴尼亚'] | 1868 | ['特立尼达和多巴哥'] |
0356 | ['马耳他'] | 1869 | ['圣基茨和尼维斯'] |
0357 | ['塞浦路斯'] | 1876 | ['牙买加'] |
0358 | ['芬兰', '奥兰'] | 6721 | ['南极洲'] |
0359 | ['保加利亚'] | 6722 | ['科科斯(基林)群岛'] |
0370 | ['立陶宛'] | 6723 | ['诺福克岛'] |
0371 | ['拉脱维亚'] | 6724 | ['圣诞岛'] |