/** * 做任务事件详情 */ export interface TaskEvent { /** *

营销活动ID

*/ PromotionId?: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

任务ID

*/ TaskId?: string; /** *

任务名称

*/ TaskName?: string; /** *

任务类型,如签到打卡、观看广告、累计步数等

*/ TaskType?: string; /** *

任务完成耗时

单位:毫秒

*/ TaskCostTime?: number; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 数字订单 */ export interface DigitalOrder { /** *

数字资产

*/ DigitalAsset?: string; /** *

数字资产类型

枚举值:

*/ AssetType?: string; /** *

订单类型

枚举值:

*/ OrderType?: string; /** *

数字资产的数量

*/ Volume?: number; } /** * 账单信息 */ export interface Billing { /** *

账单地址

*/ Address?: Address; /** *

账单联系电话

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ Phone?: string; /** *

账单邮箱

*/ Email?: string; /** *

账单接收人姓名

*/ Recipient?: string; } /** * 决策信息 */ export interface Decision { /** *

决策结果

*/ DecisionResult?: string; /** *

命中策略后的决策动作,可在控制台配置

注意:此字段可能返回 null,表示取不到有效值。 */ Disposition?: string; } /** * 个人信息 */ export interface Person { /** *

姓名全称

*/ Name?: string; /** *

性别

*/ Gender?: string; /** *

出生日期

参数格式:YYYY-MM-DD

*/ Birthday?: string; /** *

学历

*/ Degree?: string; /** *

职业

*/ Occupation?: string; } /** * 环境基础信息 */ export interface Environment { /** *

IP地理位置信息

*/ Location?: IPLocation; /** *

IP基础网络信息

*/ Network?: IPNetwork; } /** * 数字钱包 */ export interface Wallet { /** *

钱包类型

枚举值:

*/ WalletType: string; /** *

钱包地址,通常为钱包的唯一标识

*/ WalletAddress: string; /** *

钱包归属人姓名

*/ WalletHolderName?: string; /** *

钱包供应商,wechat、alipay、paypal等

*/ WalletProvider?: string; } /** * 风险分 */ export interface Score { /** *

风险分值,范围[1, 1000],分值越大,风险越高

*/ RiskScore?: number; /** *

风险标签

*/ RiskLabels?: Array; } /** * 领红包事件详情 */ export interface ClaimRedPacketEvent { /** *

营销活动ID

*/ PromotionId?: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

红包ID

*/ RedPacketId?: string; /** *

红包类型,如手气红包、口令红包、均分红包等

*/ RedPacketType?: string; /** *

红包金额

*/ RedPacketAmount?: Amount; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 营销活动码 */ export interface PromotionCode { /** *

活动码ID

*/ Id: string; /** *

活动码类型,例如:qrcode-二维码、barcode-条形码、miniprogram_code-小程序码

*/ Type?: string; /** *

活动码图片URL或链接

*/ ImageLink?: string; /** *

营销活动码使用地址

*/ Address?: Address; /** *

营销活动码关联的商品

*/ Items?: Array; } /** * 拒付事件详情 */ export interface ChargeBackEvent { /** *

交易ID

*/ TransactionId: string; /** *

订单 ID,当一笔交易关联多个订单(合并支付)时请输入所有订单ID

*/ OrderId: Array; /** *

拒付理由码,参考各卡组织定义的拒付码,例如:10.1、13.1、 4870、4871等

*/ ChargeBackCode: string; /** *

拒付原因,参考各卡组织定义的拒付原因,例如:未收到商品、欺诈等

*/ ChargeBackReason: string; /** *

拒付申诉阶段

枚举值:

  • need_response: 需要商家回应
  • information_supplied: 商家已提供信息
  • chargeback_reversed: 拒付已撤销
  • chargeback_sustained: 拒付已成立
*/ ChargeBackProcess?: string; /** *

拒付金额

*/ ChargeBackAmount?: Amount; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * ReportEvent请求参数结构体 */ export interface ReportEventRequest { /** *

事件码。用于指定业务接入的场景节点。

账号保护产品下的标准事件包含:

  • login: 登录

  • register: 注册
  • sms: 短信
  • logout: 登出
  • modify_account: 修改账号
  • modify_password: 修改密码
  • security_verification: 安全验证

交易保护产品下的标准事件包含:

  • create_order: 创建订单
  • transaction: 交易支付
  • charge_back: 拒付

营销保护产品下的标准事件包含:

  • add_promotion: 参加营销活动
  • redeem: 兑奖
  • withdraw: 提现
  • cust_event: 自定义事件,cust_xxx
  • scan_code: 扫码
  • lucky_draw: 抽奖
  • task: 做任务
  • invitation: 邀请
  • claim_red_packet: 领红包
  • browse: 浏览

自定义事件可与RCE约定后进行风险评估

*/ EventCode: string; /** *

事件的发生时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ EventTime: string; /** *

用户当前会话 ID, 用于关联用户登录前后的动作,如果没有传UserId,则SessionId必传,如缺失则可填充空字符串

*/ SessionId: string; /** *

用户设备指纹token标识,在您的网站或者应用程序中集成设备指纹的SDK后获取

*/ DeviceToken: string; /** *

客户端 IP 地址(IPv4或IPv6)

*/ UserIp: string; /** *

事件详情,根据您输入的事件码传入对应的事件信息

*/ EventDetail: EventDetail; /** *

用户在您系统中的唯一ID

*/ UserId?: string; /** *

用户邮箱

*/ UserEmail?: string; /** *

用户提供的联系方式

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ UserPhone?: string; /** *

web浏览器相关信息,若您已集成我们的设备指纹SDK,则无需传入此字段

*/ Browser?: Browser; /** *

应用程序、操作系统和移动设备详细信息,若您已集成我们的设备指纹SDK,则无需传入此字段

*/ App?: App; /** *

数据授权信息,境内地域必填

*/ DataAuthorization?: DataAuthorization; /** *

手机号码加密方式,境内地域必填

枚举值:

  • md5: md5加密
  • plain: 明文
*/ UserPhoneEncrypt?: string; /** *

微信开放账号

*/ WeChatOpenId?: string; /** *

QQ开放账号

*/ QQOpenId?: string; /** *

QQ应用ID,当传入QQ开放账号时,该字段必填,QQ分配给网站或应用的AppId,用来唯一标识网站或应用

*/ QQAppId?: string; } /** * 提现事件详情 */ export interface WithdrawEvent { /** *

提现金额

*/ Amount: Amount; /** *

提现方式

枚举值:

  • card: 银行卡
  • wallet: 电子钱包
*/ Method: string; /** *

提现银行卡,当提现方式是card时必填

*/ Card?: Card; /** *

提现数字钱包,当提现方式是wallet时必填

*/ Wallet?: Wallet; /** *

提现结果

*/ Result?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 商家信息 */ export interface Merchant { /** *

商家ID

*/ MerchantId: string; /** *

商家名称

*/ Name?: string; /** *

商家的注册时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ RegisterTime?: string; /** *

商家类别代码

参数格式:符合ISO 18245标准的4位编号

*/ Category?: string; /** *

商家电话

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ Phone?: string; /** *

商家邮件

*/ Email?: string; /** *

商家店铺网址

*/ URL?: string; /** *

商家地址

*/ Address?: Address; /** *

商家等级

*/ Level?: string; /** *

经营类型

枚举值:

  • person: 个人
  • company: 企业
*/ BusinessType?: string; /** *

商家在售商品数量

*/ GoodsQuantity?: number; /** *

商家历史销售数量

*/ HistoricSalesQuantity?: number; /** *

商家历史销售总额

*/ HistoricSalesAmount?: Amount; } /** * 物流信息 */ export interface Delivery { /** *

物流方式

  • physical:物理投送
  • electonic:电子投送
*/ DeliveryMethod?: string; /** *

物流费用

*/ DeliveryAmount?: Amount; /** *

收货地址

*/ DeliveryAddress?: Address; /** *

收货人电话

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ ConsigneePhone?: string; /** *

收货人邮箱

*/ ConsigneeEmail?: string; /** *

收货人姓名

*/ ConsigneeName?: string; /** *

是否加急

*/ Expedited?: boolean; /** *

物流厂商,一般是物流的公司

*/ DeliveryCarrier?: string; /** *

物流追踪单号

*/ DeliveryTracking?: string; } /** * 与RCE约定的定制化参数,K:V 格式的对象数组 */ export interface Cust { /** *

标识符

*/ Key?: string; /** *

数据

注意:此字段可能返回 null,表示取不到有效值。 */ Value?: string; } /** * 环境风险评估返回结果 */ export interface AssessEnvironmentRiskRsp { /** *

IP环境风险分信息

*/ Score?: DataScore; /** *

IP环境基础信息

*/ Environment?: Environment; } /** * AssessEnvironmentRisk返回参数结构体 */ export interface AssessEnvironmentRiskResponse { /** *

环境风险评估返回结果

*/ Data?: AssessEnvironmentRiskRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 支付方式,支持多种支付方式 */ export interface PaymentMethod { /** *

支付方式

枚举值:

  • cash: 现金
  • check: 支票
  • credit_card: 信用卡
  • debit_card: 借记卡
  • crypto_currency: 加密货币
  • digital_wallet: 数字钱包
  • gift_card: 礼品卡
  • points: 积分
  • in_app_purchase: APP内购买
  • electronic_fund_transfer: 电子资金转账
  • financing: 融资
  • invoice: 发票
  • prepaid_card: 预付卡
  • sepa_credit: SEPA信用转账
*/ PaymentType: string; /** *

支付渠道

*/ PaymentChannel?: string; /** *

银行卡信息,当用支付方式是credit_card、debit_card时必填

*/ Card?: Card; /** *

SEPA直接借记授权

枚举值:

  • true: 是
  • false: 否
*/ SEPADirectDebitMandate?: boolean; /** *

数字钱包

*/ DigitalWallet?: Wallet; } /** * 抽奖事件详情 */ export interface LuckyDrawEvent { /** *

营销活动ID

*/ PromotionId?: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

抽奖次数

单位:次数

*/ LuckyDrawCount?: number; /** *

抽奖类型

*/ LuckyDrawType?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * AssessDeviceRiskPremiumPro请求参数结构体 */ export interface AssessDeviceRiskPremiumProRequest { /** *

用户设备指纹token标识,在您的网站或者应用程序中集成设备指纹的SDK后获取

*/ DeviceToken: string; /** *

客户端 IP 地址(IPv4或IPv6)

*/ UserIp?: string; } /** * 订单信息 */ export interface Order { /** *

订单ID

*/ OrderId: string; /** *

订单金额

*/ Amount: Amount; /** *

商品信息

*/ Items?: Array; /** *

物流信息

*/ Delivery?: Delivery; } /** * AssessDeviceRiskPro返回参数结构体 */ export interface AssessDeviceRiskProResponse { /** *

设备风险评估基础版返回结果

*/ Data?: AssessDeviceRiskRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 账号信息 */ export interface User { /** *

用户等级

*/ UserLevel?: string; /** *

用户积分

*/ UserPoint?: CreditPoint; /** *

用户类型

*/ UserType?: string; } /** * 地址 */ export interface Address { /** *

国家

参数格式:符合ISO 3166标准

*/ Country?: string; /** *

省份

*/ Region?: string; /** *

城市

*/ City?: string; /** *

地区

*/ District?: string; /** *

详细地址

*/ Detail?: string; /** *

邮政编码

*/ ZipCode?: string; } /** * 设备基础信息 */ export interface Device { /** *

设备ID

*/ DeviceId?: string; /** *

App版本信息

*/ AppVersion?: string; /** *

品牌

*/ Brand?: string; /** *

客户端IP

*/ ClientIp?: string; /** *

机型

*/ Model?: string; /** *

网络类型

*/ NetworkType?: string; /** *

应用包名

*/ PackageName?: string; /** *

平台

枚举值:

  • 2: Android
  • 3: IOS
  • 4: H5
  • 5: 微信小程序
*/ Platform?: string; /** *

系统版本

*/ SystemVersion?: string; /** *

SDK版本

*/ SdkBuildVersion?: string; /** *

验签token,验签功能启用请联系我们。

*/ SignToken?: string; /** *

token生成时间戳,毫秒级。

*/ TokenTime?: string; /** *

隐私浏览器类型,当检测到隐私浏览器时返回,仅H5。

*/ PrivacyBrowser?: string; } /** * 数据授权信息 */ export interface DataAuthorization { /** *

数据委托方,客户主体名称

*/ DataProviderName?: string; /** *

数据受托方,腾讯云主体名称,固定填:腾讯云计算(北京)有限责任公司

*/ DataRecipientName?: string; /** *

客户请求RCE所提供的用户数据类型,支持多选

枚举值:

  • 1: 手机号
  • 2: 微信开放账号
  • 3: QQ开放账号
  • 4: IP地址
  • 5: URL网址
  • 999: 其他
*/ UserDataType?: Array; /** *

客户是否已按合规指南要求获取用户授权,同意客户委托腾讯云处理入参信息

枚举值:

  • true: 已授权
  • false: 未授权
*/ IsAuthorized?: boolean; /** *

客户是否已按合规指南要求获取用户授权,同意腾讯云结合客户提供的信息,对已合法收集的用户数据进行必要处理得出服务结果,并返回给客户

枚举值:

  • true: 已授权
  • false: 未授权
*/ IsOrderHanding?: boolean; /** *

客户获得的用户授权期限Unix时间戳(单位秒),不填默认无固定期限

*/ AuthorizationDeadline?: number; /** *

客户获得用户授权所依赖的协议地址

*/ PrivacyPolicyLink?: string; } /** * 创建订单事件详情 */ export interface CreateOrderEvent { /** *

订单ID

*/ OrderId: string; /** *

订单金额

*/ Amount: Amount; /** *

商家信息

*/ Merchant: Merchant; /** *

账单信息

*/ Billing?: Billing; /** *

商品信息

*/ Items?: Array; /** *

物流信息

*/ Delivery?: Delivery; /** *

营销活动信息

*/ Promotions?: Array; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 银行卡 */ export interface Card { /** *

发卡行识别码卡号前6位

参数格式:符合ISO 13616-1标准

*/ CardBin: string; /** *

发卡行识别码卡号后4位

参数格式:符合ISO 13616-1标准

*/ LastFourDigits: string; /** *

发行国家

*/ Country?: string; /** *

发行银行

*/ Bank?: string; /** *

支付卡类型

枚举值:

  • credit: 信用卡
  • debit: 借记卡
  • charge: 签账卡
*/ Type?: string; /** *

支付卡品牌

*/ Brand?: string; /** *

支付卡等级

*/ Level?: string; /** *

持有者姓名

*/ HolderName?: string; /** *

过期日期

参数格式:YYYY-MM-DD

*/ ExpireTime?: string; } /** * 事件结果 */ export interface Result { /** *

实际是否完成状态

枚举值:

  • success: 成功
  • failure: 失败
*/ Status: string; /** *

失败原因

*/ FailureReason?: string; } /** * ReportEvent返回参数结构体 */ export interface ReportEventResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 风险标签 */ export interface RiskLabel { /** *

风险ID

*/ Id?: string; /** *

风险描述

*/ Reason?: string; } /** * 自定义事件 */ export interface CustEvent { /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * IP地理位置信息 */ export interface IPLocation { /** *

IP地址所属国家

*/ Country?: string; /** *

IP地址所属省份

*/ Region?: string; /** *

IP地址所属城市

*/ City?: string; /** *

IP地址所属地区

*/ District?: string; /** *

IP地址的经度

*/ Longitude?: string; /** *

IP地址的纬度

*/ Latitude?: string; /** *

IP地址所属时区

*/ Timezone?: string; /** *

IP地址的邮政编码

*/ ZipCode?: string; } /** * 风险分信息 */ export interface DataScore { /** *

风险等级

*/ RiskLevel?: number; /** *

风险标签

*/ RiskLabels?: Array; /** *

综合风险分数。

取值范围:[1, 1000]

数值越大,风险越大。

注意:此字段可能返回 null,表示取不到有效值。 */ RiskScore?: number; } /** * 浏览事件详情 */ export interface BrowseEvent { /** *

当前浏览网页的类型,例如主页、搜索页等

*/ PageType?: string; /** *

当前浏览的网页URL

*/ PageUrl?: string; /** *

浏览耗时

单位:毫秒

*/ Duration?: number; /** *

网页内容类型,例如广告、视频、文章等

*/ ContentType?: string; /** *

网页内容ID

*/ ContentId?: string; /** *

上一个网页的类型,例如主页、搜索页等

*/ ReferPageType?: string; /** *

上一个网页URL

*/ ReferPageUrl?: string; /** *

游客账号ID

*/ GuestId?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * AssessDeviceRiskPremiumPro返回参数结构体 */ export interface AssessDeviceRiskPremiumProResponse { /** *

设备风险评估高级版返回结果

*/ Data?: AssessDeviceRiskPremiumRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AssessDeviceRiskPro请求参数结构体 */ export interface AssessDeviceRiskProRequest { /** *

用户设备指纹token标识,在您的网站或者应用程序中集成设备指纹的SDK后获取

*/ DeviceToken: string; /** *

客户端 IP 地址(IPv4或IPv6)

*/ UserIp?: string; } /** * 账号积分 */ export interface CreditPoint { /** *

积分分值

*/ Point: number; /** *

积分类型

*/ PointType: string; } /** * 商品信息 */ export interface Item { /** *

商品ID

*/ ItemId: string; /** *

商品名称

*/ ItemName?: string; /** *

商品类别

*/ Category?: string; /** *

商品单价

*/ Price?: Amount; /** *

如果商品有UPC码(Universal Product Code),请提供

*/ UPC?: string; /** *

如果商品有EAN码(European Article Number),请提供

*/ EAN?: string; /** *

如果商品有SKU码(Stock Keeping Unit),请提供

*/ SKU?: string; /** *

如果商品有ISBN码(International Standard Book Number ),请提供

*/ ISBN?: string; /** *

商品品牌

*/ Brand?: string; /** *

商品数量

*/ Quantity?: number; /** *

生产厂商

*/ Manufacturer?: string; /** *

商品标签

*/ Tags?: string; } /** * 金额 */ export interface Amount { /** *

原始货币类型

参数格式:符合ISO 4217标准

*/ Currency: string; /** *

原始金额

*/ OriginalAmount: number; /** *

当前币种对美金的汇率

*/ ExchangeRateUSD?: number; /** *

当前币种对人民币的汇率

*/ ExchangeRateCNY?: number; } /** * 短信事件详情 */ export interface SMSEvent { /** *

用户基础信息

*/ UserInfo?: User; /** *

本次短信发送标识 ID

*/ SMSId?: string; /** *

用户实际完成验证码时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ ReceivedTime?: string; /** *

记录用户收到短信的动作

  • no_action:用户无动作
  • safe:用户确认本人操作
  • compromised:用户反馈为第三方操作
*/ Action?: string; /** *

短信回执结果

*/ SMSResult?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * AssessRisk返回参数结构体 */ export interface AssessRiskResponse { /** *

事件风险评估结果

*/ Data?: AssessRiskRsp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AssessEnvironmentRisk请求参数结构体 */ export interface AssessEnvironmentRiskRequest { /** *

客户端 IP 地址(IPv4或IPv6)

*/ UserIp: string; } /** * 参加营销活动事件详情 */ export interface AddPromotionEvent { /** *

营销活动ID

*/ PromotionId: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

营销活动关联的优惠券

*/ Coupon?: Coupon; /** *

营销活动关联的积分活动

*/ Point?: CreditPoint; /** *

参加营销活动结果

*/ Result?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 营销活动 */ export interface Promotion { /** *

营销活动ID

*/ PromotionId: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

优惠券

*/ Coupon?: Coupon; /** *

积分

*/ CreditPoint?: CreditPoint; } /** * 修改账号事件详情 */ export interface ModifyAccountEvent { /** *

用户基础信息

*/ UserInfo?: User; /** *

用户填写的个人信息

*/ Person?: Person; /** *

用户填写的账单地址

*/ BillingAddress?: Address; /** *

用户填写的收货地址

*/ DeliveryAddress?: Address; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 邀请人信息 */ export interface Inviter { /** *

邀请人ID

*/ InviterUserId: string; /** *

邀请人电话号码

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ InviterPhone?: string; /** *

邀请码

*/ InviteCode?: string; /** *

邀请渠道

*/ InviteChannel?: string; } /** * 登出事件详情 */ export interface LogoutEvent { /** *

用户基础信息

*/ UserInfo?: User; /** *

用户登录时输入的用户名

*/ UserLoginName?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 浏览器信息 */ export interface Browser { /** *

与网站交互的浏览器的用户代理

*/ UserAgent?: string; /** *

浏览器支持的用户请求语言

参数格式:符合ISO 3166标准

*/ AcceptLanguage?: string; /** *

浏览器当前网站内容的语言

参数格式:符合ISO 3166标准

*/ ContentLanguage?: string; } /** * 支付结果 */ export interface PaymentResult { /** *

支付状态

枚举值:

  • success: 成功
  • failure: 失败
*/ Status: string; /** *

支付失败原因

*/ FailureReason?: string; /** *

是否使用3DS,枚举值:

  • 是:true
  • 否:false
*/ ThreeDomainSecure?: boolean; /** *

ECI返回码

*/ ECICode?: string; /** *

AVS响应结果(地址验证)

*/ AVSCode?: string; /** *

CVC验证结果(交易真实性验证)

*/ CVCCode?: string; } /** * 交易事件详情 */ export interface TransactionEvent { /** *

交易唯一标识

*/ TransactionId: string; /** *

您系统中的订单 ID,当一笔交易关联多个订单(合并支付)时请输入所有订单ID

*/ OrderId: Array; /** *

交易金额

*/ PaymentAmount: Amount; /** *

支付方式,支持多种支付方式

*/ PaymentMethod: PaymentMethod; /** *

交易类型

枚举值:

  • sale: 一次性完成授权与扣款(最常见)
  • authorize: 仅授权(冻结金额)
  • capture: 执行扣款(在授权后)
  • void: 取消待处理的授权或扣款
  • refund: 退款(部分或全部)
  • deposit: 向账户存款
  • withdrawal: 从账户提现
  • transfer: 账户间转账
  • buy: 购买资产(如加密货币)
  • sell: 出售资产
  • send: 发送资金/资产(如跨钱包转账)
  • receive: 接收资金/资产

默认值:sale

*/ TransactionType?: string; /** *

账单信息

*/ Billing?: Billing; /** *

物流信息

*/ Delivery?: Delivery; /** *

商家信息

*/ Merchant?: Merchant; /** *

支付结果

*/ PaymentResult?: PaymentResult; /** *

接收方的用户ID,适用于 transfer 交易类型

*/ TransferRecipientUserId?: string; /** *

发送方的物理地址,适用于 transfer 交易类型

*/ TransferSentAddress?: Address; /** *

接收方的物理地址,适用于 transfer 交易类型

*/ TransferReceivedAddress?: Address; /** *

数字订单列表

*/ DigitalOrders?: Array; /** *

接收加密货币的钱包

*/ ReceiverWallet?: Wallet; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 事件风险评估返回结果 */ export interface AssessRiskRsp { /** *

决策信息

*/ Decision?: Decision; /** *

风险分,根据您开启的产品服务计算的评分结果

*/ Score?: Score; /** *

扩展信息

注意:此字段可能返回 null,表示取不到有效值。 */ ExtraInfo?: Array; } /** * 修改密码事件详情 */ export interface ModifyPasswordEvent { /** *

修改原因

枚举值:

  • user_modify: 用户主动修改
  • forgot_password: 忘记密码
  • forced_reset: 系统强制重置
*/ Reason?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 设备风险评估基础版返回结果 */ export interface AssessDeviceRiskRsp { /** *

设备风险分信息

*/ Score?: DataScore; /** *

设备基础信息

*/ Device?: Device; /** *

IP环境基础信息

注意:此字段可能返回 null,表示取不到有效值。 */ Environment?: Environment; } /** * 优惠券 */ export interface Coupon { /** *

优惠券ID

*/ CouponId?: string; /** *

优惠券名称

*/ CouponName?: string; /** *

优惠券开始时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ StartTime?: string; /** *

优惠券过期时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ ExpireTime?: string; /** *

折扣百分比,如果折扣为 10%,则发送“0.1”

*/ PercentageRate?: number; /** *

折扣金额

*/ DiscountAmount?: Amount; /** *

优惠券门槛

*/ Threshold?: number; } /** * 注册事件详情 */ export interface RegisterEvent { /** *

注册结果

*/ RegisterResult?: Result; /** *

用户基础信息

*/ UserInfo?: User; /** *

用户注册时填写的个人信息

*/ Person?: Person; /** *

用户注册时填写的账单地址

*/ BillingAddress?: Address; /** *

用户注册时填写的收货地址

*/ DeliveryAddress?: Address; /** *

邀请人信息

*/ Inviter?: Inviter; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 应用程序信息 */ export interface App { /** *

应用程序运行的移动设备的操作系统类型

*/ OS?: string; /** *

应用程序运行的移动设备的操作系统版本

*/ OSVersion?: string; /** *

应用程序运行的移动设备的生产厂商

*/ DeviceManufacturer?: string; /** *

应用程序运行的移动设备的型号

*/ DeviceModel?: string; /** *

应用程序运行的移动设备的唯一ID,对于iOS为IFV标识,对于Android为Android ID

*/ DeviceId?: string; /** *

应用程序名称

*/ AppName?: string; /** *

应用程序版本

*/ AppVersion?: string; /** *

应用程序提供的语言

*/ ClientLanguage?: string; } /** * 登录事件详情 */ export interface LoginEvent { /** *

用户基础信息

*/ UserInfo?: User; /** *

用户登录时输入的用户名

*/ UserLoginName?: string; /** *

登录结果

*/ LoginResult?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 事件详情 */ export interface EventDetail { /** *

登录

*/ Login?: LoginEvent; /** *

注册(变更用户信息)

*/ Register?: RegisterEvent; /** *

创建订单

*/ CreateOrder?: CreateOrderEvent; /** *

交易支付

*/ Transaction?: TransactionEvent; /** *

短信

*/ Sms?: SMSEvent; /** *

拒付

*/ ChargeBack?: ChargeBackEvent; /** *

登出

*/ Logout?: LogoutEvent; /** *

修改账号

*/ ModifyAccount?: ModifyAccountEvent; /** *

修改密码

*/ ModifyPassword?: ModifyPasswordEvent; /** *

安全验证

*/ SecurityVerification?: SecurityVerificationEvent; /** *

参加营销活动

*/ AddPromotion?: AddPromotionEvent; /** *

兑奖

*/ Redeem?: RedeemEvent; /** *

提现

*/ Withdraw?: WithdrawEvent; /** *

自定义事件

*/ CustEvent?: CustEvent; /** *

扫码

*/ ScanCode?: ScanCodeEvent; /** *

抽奖

*/ LuckyDraw?: LuckyDrawEvent; /** *

做任务

*/ Task?: TaskEvent; /** *

邀请

*/ Invitation?: InvitationEvent; /** *

领红包

*/ ClaimRedPacket?: ClaimRedPacketEvent; /** *

浏览

*/ Browse?: BrowseEvent; } /** * IP基础网络信息 */ export interface IPNetwork { /** *

互联网服务提供商

*/ ISP?: string; /** *

自治系统号

*/ ASN?: string; /** *

IP注册组织名称

*/ Organization?: string; /** *

是否保留IP

*/ IsReserved?: boolean; /** *

是否网关IP

*/ IsGateway?: boolean; /** *

是否任播网络

*/ IsAnycast?: boolean; /** *

是否移动网络

*/ IsMobile?: boolean; /** *

是否动态IP

*/ IsDynamic?: boolean; /** *

是否网络出口

*/ IsEgress?: boolean; /** *

是否域名解析

*/ IsDNS?: boolean; /** *

是否教育机构

*/ IsEducation?: boolean; /** *

是否组织机构

*/ IsInstitution?: boolean; /** *

是否企业专线

*/ IsCompany?: boolean; /** *

是否家用宽带

*/ IsResidence?: boolean; /** *

是否云服务

*/ IsCloudService?: boolean; /** *

是否基础设施

*/ IsInfrastructure?: boolean; /** *

是否邮箱服务

*/ IsMXServer?: boolean; } /** * 安全验证事件详情 */ export interface SecurityVerificationEvent { /** *

安全验证所处的事件类型

枚举值:

  • register: 注册
  • login: 登录
  • modify_account: 修改账号
  • modify_password: 修改密码
  • create_order: 创建订单
  • transaction: 交易支付
  • modify_order: 修改订单
  • withdraw: 提现
  • add_promotion: 参加营销活动
  • redeem: 兑奖
*/ VerificationEvent: string; /** *

安全验证类型,sms-短信、phone_call-电话、email-邮件、captcha-验证码、shared_knowledge-共享知识、face-人脸、fingerprint-指纹等

*/ VerificationType: string; /** *

安全验证的内容,例如:用于验证的电话号码、邮件、验证码或者问题,当安全验证类型是sms、phone_call、email、captcha、shared_knowledge时输入

*/ VerificationContent?: string; /** *

安全验证结果

*/ VerificationResult?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 设备风险评估高级版返回结果 */ export interface AssessDeviceRiskPremiumRsp { /** *

决策信息

*/ Decision?: Decision; /** *

设备风险分信息

*/ Score?: DataScore; /** *

设备基础信息

*/ Device?: Device; /** *

IP环境基础信息

注意:此字段可能返回 null,表示取不到有效值。 */ Environment?: Environment; } /** * 兑奖事件详情 */ export interface RedeemEvent { /** *

营销活动ID

*/ PromotionId: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

兑奖关联的订单信息

*/ Order?: Order; /** *

兑奖结果

*/ Result?: Result; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * 邀请事件详情 */ export interface InvitationEvent { /** *

受邀请人ID

*/ InviteeUserId: string; /** *

营销活动ID

*/ PromotionId?: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

受邀请人电话号码

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ InviteePhone?: string; /** *

邀请码

*/ InvitationCode?: string; /** *

邀请链接

*/ InvitationUrl?: string; /** *

邀请渠道,如微信、抖音、小红书等

*/ InvitationChannel?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组,示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; } /** * AssessRisk请求参数结构体 */ export interface AssessRiskRequest { /** *

事件码。用于指定业务接入的场景节点。

账号保护产品下的标准事件包含:

  • login: 登录

  • register: 注册
  • sms: 短信
  • logout: 登出
  • modify_account: 修改账号
  • modify_password: 修改密码
  • security_verification: 安全验证

交易保护产品下的标准事件包含:

  • create_order: 创建订单
  • transaction: 交易支付
  • charge_back: 拒付

营销保护产品下的标准事件包含:

  • add_promotion: 参加营销活动
  • redeem: 兑奖
  • withdraw: 提现
  • cust_event: 自定义事件,cust_xxx
  • scan_code: 扫码
  • lucky_draw: 抽奖
  • task: 做任务
  • invitation: 邀请
  • claim_red_packet: 领红包
  • browse: 浏览

自定义事件可与RCE约定后进行风险评估

*/ EventCode: string; /** *

事件的发生时间

参数格式:符合ISO 8601标准的带UTC时区的毫秒级时间

*/ EventTime: string; /** *

用户当前会话 ID, 用于关联用户登录前后的动作,如果没有传UserId,则SessionId必传,如缺失则可填充空字符串

*/ SessionId: string; /** *

用户设备指纹token标识,在您的网站或者应用程序中集成设备指纹的SDK后获取

*/ DeviceToken: string; /** *

客户端 IP 地址(IPv4或IPv6)

*/ UserIp: string; /** *

事件详情,根据您输入的事件码传入对应的事件信息

*/ EventDetail: EventDetail; /** *

用户在您系统中的唯一ID

*/ UserId?: string; /** *

用户邮箱

*/ UserEmail?: string; /** *

用户提供的联系方式

参数格式:符合E.164标准的带“+”、地区编码和号码的格式

*/ UserPhone?: string; /** *

web浏览器相关信息,若您已集成我们的设备指纹SDK,则无需传入此字段

*/ Browser?: Browser; /** *

应用程序、操作系统和移动设备详细信息,若您已集成我们的设备指纹SDK,则无需传入此字段

*/ App?: App; /** *

数据授权信息,境内地域必填

*/ DataAuthorization?: DataAuthorization; /** *

手机号码加密方式,境内地域必填

枚举值:

  • md5: md5加密
  • plain: 明文
*/ UserPhoneEncrypt?: string; /** *

微信开放账号

*/ WeChatOpenId?: string; /** *

QQ开放账号

*/ QQOpenId?: string; /** *

QQ应用ID,当传入QQ开放账号时,该字段必填,QQ分配给网站或应用的AppId,用来唯一标识网站或应用

*/ QQAppId?: string; } /** * 扫码事件详情 */ export interface ScanCodeEvent { /** *

营销活动码

*/ PromotionCode: PromotionCode; /** *

营销活动ID

*/ PromotionId?: string; /** *

营销活动名称

*/ PromotionName?: string; /** *

营销活动描述

*/ Description?: string; /** *

邀请人ID

*/ InviterUserId?: string; /** *

与RCE约定的定制化信息,为K:V 格式的对象数组, 示例:[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

*/ Cust?: Array; }