tencent cloud

Risk Control Engine

Data Types

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-09-11 11:52:06

AddPromotionEvent

AddPromotion event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String Yes

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

Coupon Coupon No

The coupon associated with the promotion

Point CreditPoint No

The point associated with the promotion

Result Result No

The result of participating the promotion

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131***85678"}]

Address

Address

Used by actions: ReportEvent.

Name Type Required Description
Country String No

Country

Parameter format: Compliant with the ISO 3166 standard

Region String No

Province

City String No

City

District String No

Region

Detail String No

Detailed address

ZipCode String No

Postal code

Amount

Amount

Used by actions: ReportEvent.

Name Type Required Description
Currency String Yes

Currency code

Parameter format: Compliant with the ISO 4217 standard

OriginalAmount Float Yes

Original amount in currency

ExchangeRateUSD Float No

Current exchange rate of base currency converted to USD

ExchangeRateCNY Float No

Current exchange rate of base currency converted to CNY

App

The details of the app, os and device

Used by actions: ReportEvent.

Name Type Required Description
OS String No

The operating system your application is running on

OSVersion String No

The operating system version your application is running on

DeviceManufacturer String No

The manufacturer of the device your application is running on

DeviceModel String No

The model of the device your application is running on

DeviceId String No

The ID of the device your application is running on

AppName String No

The name of your application

AppVersion String No

The version of your application

ClientLanguage String No

The language of your application

AssessDeviceRiskPremiumRsp

The results of AssessDeviceRiskPremiumPro

Used by actions: AssessDeviceRiskPremiumPro.

Name Type Description
Decision Decision

Decision information

Score DataScore

The risk score information of the device

Device Device

The basic information of the device

Environment Environment

Basic IP environment information

AssessDeviceRiskRsp

The results of AssessDeviceRiskPro

Used by actions: AssessDeviceRiskPro.

Name Type Description
Score DataScore

The risk score information of the device

Device Device

The basic information of the device

Environment Environment

Basic IP environment information

AssessEnvironmentRiskRsp

The results of AssessEnvironmentRisk

Used by actions: AssessEnvironmentRisk.

Name Type Description
Score DataScore

The risk score information of the IP environment

Environment Environment

The basic information of the IP environment

Billing

Bill information

Used by actions: ReportEvent.

Name Type Required Description
Address Address No

The billing address associated with this user

Phone String No

The phone number associated with the bill

Parameter format: Complies with the E.164 standard, using the format with "+", region code, and number

Email String No

The email associated with the bill

Recipient String No

The name of the receiver associated with the bill

BrowseEvent

Browse event details

Used by actions: ReportEvent.

Name Type Required Description
PageType String No

Current page type such as home page, search page

PageUrl String No

Currently page URL

Duration Integer No

Browsing duration

Measurement unit: ms

ContentType String No

The type of the content in current page such as ad, video, article

ContentId String No

The ID of the content in current page

ReferPageType String No

Previous page type such as home page, search page

ReferPageUrl String No

Previous page URL

GuestId String No

The ID of the user as guest

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Browser

Browser information

Used by actions: ReportEvent.

Name Type Required Description
UserAgent String No

The user agent of the browser that interacts with the website

AcceptLanguage String No

The language(s) that the client prefers

Parameter format: Complies with the ISO 3166 standard

ContentLanguage String No

The language(s) intended for the audience

Parameter format: Compliant with ISO 3166 standard

Card

The details of the card

Used by actions: ReportEvent.

Name Type Required Description
CardBin String Yes

Bank identification number.The first six or eight digits of the card number

Parameter format: Compliant with the ISO 13616-1 standard

LastFourDigits String Yes

The last four digits of the card number

Parameter format: Compliant with ISO 13616-1 standard

Country String No

The country where the card issued

Bank String No

The bank that issued card

Type String No

the type of the card

Enumeration value:

  • credit: Credit card
  • debit: Debit card
  • charge: Charge card
Brand String No

The brand of the card

Level String No

The level of the card that the bank defined

HolderName String No

The full name of the person who hold the card

ExpireTime String No

The expiration date of the card

Parameter format: YYYY-MM-DD.

ChargeBackEvent

ChargeBack event details

Used by actions: ReportEvent.

Name Type Required Description
TransactionId String Yes

The ID of the transaction

OrderId Array of String Yes

The ID(s) of the order associated with the transaction

ChargeBackCode String Yes

The code of the chargeback defined by the card organization, for example: 10.1, 13.1, 4870, 4871

ChargeBackReason String Yes

The reason of the chargeback defined by the card organization, for example: non-receipt of goods, fraud

ChargeBackProcess String No

The process of the chargeback defined by the card organization

Enumeration values:

  • need_response: Merchant needs to respond
  • information_supplied: Merchant has provided information
  • chargeback_reversed: Chargeback has been canceled
  • chargeback_sustained: Chargeback has been established
ChargeBackAmount Amount No

The amount of the chargeback

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

ClaimRedPacketEvent

ClaimRedPacket event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String No

The ID of the promotion

PromotionName String No

The Name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

RedPacketId String No

The ID of the red packet

RedPacketType String No

The type of red packet, for example, random amount, passcode, standard

RedPacketAmount Amount No

The amount in the red packet

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Coupon

The details of the coupon

Used by actions: ReportEvent.

Name Type Required Description
CouponId String No

The unique ID of each coupon

CouponName String No

The name of the coupon

StartTime String No

The start time of the coupon

Parameter format: Millisecond-level time with UTC time zone compliant with ISO 8601.

ExpireTime String No

The expiration time of the coupon

Parameter format: Millisecond-level time with UTC time zone compliant with ISO 8601 standard

PercentageRate Float No

The percentage rate of the coupon. If discount off is 10%,please send 0.1

DiscountAmount Amount No

The discount amount of the coupon

Threshold Float No

The threshold amount of the coupon

CreateOrderEvent

CreateOrder event details

Used by actions: ReportEvent.

Name Type Required Description
OrderId String Yes

The ID of the order

Amount Amount Yes

The amount of the order

Merchant Merchant Yes

The detail information of the merchant associated with the order

Billing Billing No

The detail information of the bill associated with the order

Items Array of Item No

The detail information of the items in the order

Delivery Delivery No

The detail information of the delivery associated with the order

Promotions Array of Promotion No

The promotion(s) associated with the order

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

CreditPoint

The details of the point

Used by actions: ReportEvent.

Name Type Required Description
Point Float Yes

The value of the point

PointType String Yes

The type of the point

Cust

Customization parameters agreed with RCE, object array in K:V format

Used by actions: ReportEvent.

Name Type Required Description
Key String No

Key

Value String No

Value

CustEvent

Custom event

Used by actions: ReportEvent.

Name Type Required Description
Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

DataScore

Risk score information

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro, AssessEnvironmentRisk.

Name Type Description
RiskLevel Integer

Risk level

RiskLabels Array of RiskLabel

Risk label

RiskScore Integer

Comprehensive risk score.

Value ranges from 1 to 1000.

The larger the value, the larger the risk.

Decision

Decision information

Used by actions: AssessDeviceRiskPremiumPro.

Name Type Description
DecisionResult String

Decision result

  • pass: Pass
  • review: Review
  • reject: Reject
Disposition String

Decision action when a strategy is matched. Configurable in the console.

Delivery

Delivery information

Used by actions: ReportEvent.

Name Type Required Description
DeliveryMethod String No

The method of the delivery

  • physical
  • electronic
DeliveryAmount Amount No

The fee of the delivery

DeliveryAddress Address No

The address of the delivery

ConsigneePhone String No

Phone number of the consignee

parameter format: format with "+", region code, and number that complies with the E.164 standard

ConsigneeEmail String No

Email of the consignee

ConsigneeName String No

Full name of the consignee

Expedited Boolean No

Whether is the delivery expedited

DeliveryCarrier String No

The carrier of the delivery, usually a logistics company

DeliveryTracking String No

The number(s) used to track the delivery

Device

The basic infomation of the device

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro.

Name Type Description
DeviceId String

The unique id of device returned by RCE

AppVersion String

The version of the application

Brand String

Device brand

ClientIp String

Client IP address

Model String

Device model

NetworkType String

Network type of the device

PackageName String

The package name of the application

Platform String

Device platform

Enumeration value:

  • 2: Android
  • 3: IOS
  • 4: H5
  • 5: WeChat Mini Program
SystemVersion String

Device system version

SdkBuildVersion String

The build version of SDK

SignToken String

Signature verification token. Please contact us to enable signature verification

TokenTime String

Token generation timestamp, in milliseconds

DigitalOrder

The details of the digital order

Used by actions: ReportEvent.

Name Type Required Description
DigitalAsset String No

The name of the asset

AssetType String No

The type of the asset

Enumeration value:

  • coin
  • commodity
  • crypto
  • fiat
  • token
  • stock
  • bond
OrderType String No

The type of trade being made

Enumeration value:

  • limit: Limit order
  • market: Market order
  • stop_limit: Stop-limit order
  • stop_loss: Stop-loss order
  • take_profit: Take-profit order
  • take_profit_limit: Take-profit limit order
Volume Float No

The quantity of the digital asset

Environment

The basic information of the IP environment

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro, AssessEnvironmentRisk.

Name Type Description
Location IPLocation

The geographical location of the IP address

Network IPNetwork

The basic IP network information

EventDetail

Event details

Used by actions: ReportEvent.

Name Type Required Description
Login LoginEvent No

Login

Register RegisterEvent No

Registration

CreateOrder CreateOrderEvent No

Create an order

Transaction TransactionEvent No

Transaction

Sms SMSEvent No

SMS

ChargeBack ChargeBackEvent No

Chargeback

Logout LogoutEvent No

Logout

ModifyAccount ModifyAccountEvent No

Modify account

ModifyPassword ModifyPasswordEvent No

Modify password

SecurityVerification SecurityVerificationEvent No

Security verification

AddPromotion AddPromotionEvent No

Participate in promotion activities

Redeem RedeemEvent No

Redeem a prize

Withdraw WithdrawEvent No

Withdrawal

CustEvent CustEvent No

Custom event

ScanCode ScanCodeEvent No

Scan the QR code

LuckyDraw LuckyDrawEvent No

Lucky draw

Task TaskEvent No

Perform a task

Invitation InvitationEvent No

Invitation

ClaimRedPacket ClaimRedPacketEvent No

Receive a red packet

Browse BrowseEvent No

Browse

IPLocation

The geographical location of the IP address

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro, AssessEnvironmentRisk.

Name Type Description
Country String

The country of the IP address

Region String

The region of the IP address

City String

The city of the IP address

District String

The district of the IP address

Longitude String

The longitude of the IP address

Latitude String

The latitude of the IP address

Timezone String

The timezone of the IP address

ZipCode String

The zip code of the IP address

IPNetwork

The basic IP network information

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro, AssessEnvironmentRisk.

Name Type Description
ISP String

Internet service provider

ASN String

Autonomous system number

Organization String

IP registration organization name

IsReserved Boolean

Whether it is a reserved IP address

IsGateway Boolean

Whether it is a gateway IP address

IsAnycast Boolean

Whether it belongs to an anycast network

IsMobile Boolean

Whether it is from a mobile network

IsDynamic Boolean

Whether it is a dynamic IP address

IsEgress Boolean

Whether it is a network egress

IsDNS Boolean

Whether it is used for domain name resolution

IsEducation Boolean

Whether it is an educational institution

IsInstitution Boolean

Whether it is an organization

IsCompany Boolean

Whether it is an enterprise dedicated line

IsResidence Boolean

Whether it is a residence broadband connection

IsCloudService Boolean

Whether it is cloud service

IsInfrastructure Boolean

Whether it is infrastructure

IsMXServer Boolean

Whether it is an mail exchange service

InvitationEvent

Invitation event details

Used by actions: ReportEvent.

Name Type Required Description
InviteeUserId String Yes

The ID of the invitee

PromotionId String No

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviteePhone String No

The phone number of the invitee

Parameter format: Complies with the E.164 standard format, which includes "+", region code, and number.

InvitationCode String No

The code that the inviter sent to the user

InvitationUrl String No

The url that the inviter sent to the user

InvitationChannel String No

The channel that inviter used to invite the user

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Inviter

Inviter information

Used by actions: ReportEvent.

Name Type Required Description
InviterUserId String Yes

The ID of the inviter

InviterPhone String No

The phone number of the inviter

Parameter format: Complies with the E.164 standard format, which includes "+", region code, and number.

InviteCode String No

The code that the inviter sent to the user

InviteChannel String No

The channel that inviter used to invite the user

Item

The details of the item

Used by actions: ReportEvent.

Name Type Required Description
ItemId String Yes

The unique ID of the item

ItemName String No

The name of the item

Category String No

The category of the item

Price Amount No

The price of the item

UPC String No

If the item has a UPC (Universal Product Code), please provide it here.

EAN String No

If the item has an EAN (European Article Number), please provide it here.

SKU String No

If the item has an SKU (Stock Keeping Unit), please provide it here.

ISBN String No

If the item has an ISBN (International Standard Book Number), please provide it here.

Brand String No

The brand of the item

Quantity Integer No

The quantity of the item

Manufacturer String No

The manufacture of the item

Tags String No

The tags of the item in your system

LoginEvent

Login event detail

Used by actions: ReportEvent.

Name Type Required Description
UserInfo User No

Basic user information

UserLoginName String No

The user name entered when the user logged in

LoginResult Result No

Login result

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

LogoutEvent

Logout event details

Used by actions: ReportEvent.

Name Type Required Description
UserInfo User No

The detail information of the user

UserLoginName String No

The user name entered when the user logged in

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

LuckyDrawEvent

LuckyDraw event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String No

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

LuckyDrawCount Integer No

Number of lucky draw

Unit: count

LuckyDrawType String No

Type of lucky draw

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Merchant

The details of the merchant

Used by actions: ReportEvent.

Name Type Required Description
MerchantId String Yes

The ID of the merchant

Name String No

The name of the merchant

RegisterTime String No

Merchant registration time

Parameter format: Millisecond-level time with UTC time zone compliant with ISO 8601

Category String No

Merchant category code

Parameter format: 4-digit No. compliant with ISO 18245

Phone String No

The phone number of the merchant

parameter format: format with "+", region code, and number that complies with the E.164 standard

Email String No

The email of the merchant

URL String No

The url of the merchant shop on the website

Address Address No

The address of the merchant

Level String No

The level of the merchant

BusinessType String No

The type of the merchant

Enumeration value:

  • person: Person
  • company: Company
GoodsQuantity Integer No

The volume of goods on sale of the merchant

HistoricSalesQuantity Integer No

The historical sales volume of the merchant

HistoricSalesAmount Amount No

The historical sales amount of the merchant

ModifyAccountEvent

ModifyAccount event details

Used by actions: ReportEvent.

Name Type Required Description
UserInfo User No

The detail information of the user

Person Person No

The personal information of the account when registered

BillingAddress Address No

The billing address the user provided when registered

DeliveryAddress Address No

The delivery address the user provided when registered

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

ModifyPasswordEvent

ModifyPassword event details

Used by actions: ReportEvent.

Name Type Required Description
Reason String No

The reason why the password was updated

Enumeration value:

  • user_modify: User self-initiated modification
  • forgot_password: Forget password
  • forced_reset: System forcing reset
Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Order

The details of the order

Used by actions: ReportEvent.

Name Type Required Description
OrderId String Yes

The ID of the order

Amount Amount Yes

The amount of the order

Items Array of Item No

The detail information of the items in the order

Delivery Delivery No

The detail information of the delivery associated with the order

PaymentMethod

Payment method

Used by actions: ReportEvent.

Name Type Required Description
PaymentType String Yes

Payment method

Enumeration value:

  • cash
  • check
  • credit_card
  • debit_card
  • crypto_currency
  • digital_wallet
  • gift_card
  • points
  • in_app_purchase
  • electronic_fund_transfer
  • financing
  • invoice
  • prepaid_card
  • sepa_credit
PaymentChannel String No

The channel of the payment

Card Card No

The details of the card.Required while PaymentMethod is "credit_card","debit_card"

SEPADirectDebitMandate Boolean No

SEPA direct debit mandate

Enumeration value:

  • true: Yes
  • false: No
DigitalWallet Wallet No

The details of the digital wallet when involved digital trade

PaymentResult

Payment result

Used by actions: ReportEvent.

Name Type Required Description
Status String Yes

The status of the payment

Enumeration values:

  • success: Success,
  • failure: Failure.
FailureReason String No

The reason why the payment has been declined. e.g.card_declined

ThreeDomainSecure Boolean No

Whether the 3DS has been used in the payment, enumeration value:

  • Yes: true
  • No: false
ECICode String No

The ECI code returned when 3DS used

AVSCode String No

Response code from the AVS used for address verification

CVCCode String No

Response code from the CVC used for payment authenticity

Person

Personal information

Used by actions: ReportEvent.

Name Type Required Description
Name String No

The full name of the user if provided

Gender String No

The gender of the user if provided

Birthday String No

The birthday of the user if provided

Parameter format: YYYY-MM-DD.

Degree String No

The degree of the user if provided

Occupation String No

The occupation of the user if provided

Promotion

The details of the promotion

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String Yes

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

Coupon Coupon No

The coupon(s) associated with the promotion

CreditPoint CreditPoint No

The point(s) associated with the promotion

PromotionCode

The details of the promotion code

Used by actions: ReportEvent.

Name Type Required Description
Id String Yes

The ID of the promotion code

Type String No

The type of the promotion code, for example: qrcode, barcode, miniprogram code

ImageLink String No

The url or hyperlink to the image

Address Address No

The address where the promotion code worked

Items Array of Item No

The item(s) associated with the promotion code

RedeemEvent

Redeem event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String Yes

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

Order Order No

Order information associated with the redemption

Result Result No

The result of redemption

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

RegisterEvent

Register event details

Used by actions: ReportEvent.

Name Type Required Description
RegisterResult Result No

The result of the register

UserInfo User No

The detail information of the user

Person Person No

The personal information of the account when registered

BillingAddress Address No

The billing address the user provided when registered

DeliveryAddress Address No

The delivery address the user provided when registered

Inviter Inviter No

The detail information of the inviter who invited the user to your business

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Result

Event result

Used by actions: ReportEvent.

Name Type Required Description
Status String Yes

Actual completion status

Enumeration values:

  • success: Success,
  • failure: Failure.
FailureReason String No

Failure reason

RiskLabel

Risk label

Used by actions: AssessDeviceRiskPremiumPro, AssessDeviceRiskPro, AssessEnvironmentRisk.

Name Type Description
Id String

The ID of the label

Reason String

The reason of the label

SMSEvent

SMS event details

Used by actions: ReportEvent.

Name Type Required Description
UserInfo User No

The detail information of the user

SMSId String No

The unique ID of the sms

ReceivedTime String No

The time that the user received the sms

Parameter format: Millisecond-level time with UTC time zone compliant with ISO 8601 standard

Action String No

The action of the user after receiving the sms

  • no_action: No action from the user
  • safe: User confirmation of the correct person's action
  • compromised: Feedback from real users indicates third-party action
SMSResult Result No

The result of the sms

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

ScanCodeEvent

ScanCode event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionCode PromotionCode Yes

Promotion code information

PromotionId String No

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

SecurityVerificationEvent

SecurityVerification event details

Used by actions: ReportEvent.

Name Type Required Description
VerificationEvent String Yes

The event type being verified

Enumeration values:

  • register
  • login
  • modify_account
  • modify_password
  • create_order
  • transaction
  • modify_order
  • withdraw
  • add_promotion
  • redeem
VerificationType String Yes

The type of security verification: sms, phone call, email, captcha, shared knowledge, human face, fingerprint, etc

VerificationContent String No

The content of the security verifcation.This value should be passed when the verification type is set to sms, phone_call, email captcha or shared_knowledge

VerificationResult Result No

The result of security verification

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

TaskEvent

Task event details

Used by actions: ReportEvent.

Name Type Required Description
PromotionId String No

The ID of the promotion

PromotionName String No

The name of the promotion

Description String No

The description of the promotion

InviterUserId String No

The ID of the inviter

TaskId String No

The ID of the task

TaskName String No

The name of the task

TaskType String No

Task type, such as daily check-in, ad viewing, or step accumulation

TaskCostTime Integer No

Task completed duration

Measurement unit: ms

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

TransactionEvent

Transaction event details

Used by actions: ReportEvent.

Name Type Required Description
TransactionId String Yes

The unique ID of the transaction

OrderId Array of String Yes

The ID(s) of the order associated with the transaction

PaymentAmount Amount Yes

The amount of the transaction

PaymentMethod PaymentMethod Yes

The detail information of the payment method associated with the transaction

TransactionType String No

Transaction type

Enumeration value:

  • sale: One-time authorization and deduction (most common)
  • authorize: Authorization only (frozen amount)
  • capture: Execute deduction (after authorization)
  • void: Cancel pending authorization or deduction
  • refund: Refund (part or all)
  • deposit: Deposit to account
  • withdrawal: Withdrawal from account
  • transfer: Fund transfer between accounts
  • buy: Purchase asset (for example, crypto currency)
  • sell: Sell asset
  • send: Send fund/asset (for example, cross-wallet transfer)
  • receive: Receive fund/asset

Default value: sale

Billing Billing No

Bill information

Delivery Delivery No

Delivery information

Merchant Merchant No

Merchant information

PaymentResult PaymentResult No

Payment result

TransferRecipientUserId String No

The ID of the recipent in transfer transaction

TransferSentAddress Address No

The address of the sender in transfer transaction

TransferReceivedAddress Address No

Physical address of the recipient, applicable to the transfer transaction type.

DigitalOrders Array of DigitalOrder No

The digital order(s) associated with the transaction

ReceiverWallet Wallet No

Wallet to receive crypto currency

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

User

The detail information of the user

Used by actions: ReportEvent.

Name Type Required Description
UserLevel String No

The level of the user in your system

UserPoint CreditPoint No

The point of the user in your system

UserType String No

The type of the user in your system

Wallet

The details of the digital wallet

Used by actions: ReportEvent.

Name Type Required Description
WalletType String Yes

Wallet type

Enumeration value:

  • crypto: Crypto currency
  • digital: Digital currency
  • fiat: Fiat currency
WalletAddress String Yes

The address of the wallet.Usually it is the ID of the wallet.

WalletHolderName String No

The full name of the person who holds the wallet

WalletProvider String No

The provider of the wallet, such as wechat, alipay, paypal

WithdrawEvent

Withdraw event details

Used by actions: ReportEvent.

Name Type Required Description
Amount Amount Yes

The amount of the withdraw

Method String Yes

The method of the withdraw

Enumeration value:

  • card: bank card
  • wallet: digital wallet
Card Card No

The detail information of the card withdrawn to.Required while the withdraw method is card

Wallet Wallet No

The detail information of the wallet withdrawn to.Required while the withdraw method is wallet

Result Result No

Withdraw result

Cust Array of Cust No

The custom parameters agreed with RCE. An array of objects in K:V format. e.g.[{"Key": "ApproverName", "Value": "bob"},{"Key":"ApproverPhone","Value": "+86131****5678"}]

Ajuda e Suporte

Esta página foi útil?

comentários