APIKey
lang
"en"
, "fr"
.currency
"USD", "EUR"
.programName
"TRIPLE H Store"
rankPointsName
walletPointsName
botMainColor
redemption
redemptionFactor
: Indicates the monetary value which one point is equivalent to.
Example: Redemption Value of 1 point is 0.01 (redemption factor).redemptionRules
: Array of Redemption Rule objects each described as follows:ruleId
: Unique Identifier for the rule.type
: Redemption Rule type.equivalentPoints
: Equivalent amount of points to be redeemedequivalentPointsValue
: Equivalent monetary value of the specified points.productId
: In case the rule type is "FreeProduct", the productId
is the unique identifier of the product to be available for redemptionproductName
: In case the rule type is "FreeProduct", the productName
is the name of the product to be available for redemptioncontrolConfig
ObjectgameballEnabled
redemptionEnabled
cashbackEnabled
referralEnabled
visitorProfileEnabled
userProfileEnabled
leaderboardEnabled
notificationsEnabled
achievementsEnabled
level
ObjectminProgress
order
icon
name
benefits
"benefits":{
"rankReward":0,
"walletReward":0,
"levelDiscount":0,
"discountCapping":0,
"others":[]
}
rankReward
: Score rewarded upon reaching that level.walletReward
: Points rewarded upon reaching that level.levelDiscount
: The discount amount that the level grants.discountCapping
: The maximum value to which the discount is applicable.
Example: 10% discount for maximum order price 100 USDothers
: An array of statement(s) that can be used to describe the benefits of the level. challenge
Objectid
name
description
rankReward
walletReward
repeatable
maxAchievement
type
SignUp
SocialMedia
ScheduledChallenge
EventBased
HighScore
Birthday
Anniversary
visibility
"AlwaysVisibile"
"NotVisible"
"VisibleIfEarned"
icon
availability
"availability":{
"minLevel": 4,
"tags": ["VIP"]
}
minLevel
: Minimum required level for the player to be eligible to the achieve the challenge.tags
: Array of tags for which the challenge is available.referral
ObjectreferralMethod
"PlayerAndFriend"
denotes that both the referring and the referred player should be rewarded. The referred player also should complete the sign up process and perform a certain action according to your configurations."PlayerOnly"
denotes that only the referring player that should be rewarded after a successful referral."PlayerAndGuest"
denotes that both the referring and the referred player should be rewarded. Referred Player Registration is optional, but he would be rewarded after placing a successful order.eventName
eventMetaData
playerReward
"playerReward":{
"extraReward":{
"rewardEvery":5,
"rewardType":null,
"score":2,
"point":1,
"voucher":null
},
"rewardType":"Vouchers",
"score":0,
"point":0,
"voucher":{
"voucherType":"Free Shipping",
"productId":"",
"productName":"",
"value":0
}
}
playerReward
object is defined as follows:extraReward
: An object that defines the extra reward the referring player is granted after completing specific number of referrals.
"extraReward":{
"rewardEvery":5,
"rewardType":null,
"score":2,
"point":1,
"voucher":null
}
rewardEvery
:
Defines the frequency upon which the referring player is rewardedrewardType
: Defines the type of the reward, possible values are: "Vouchers"
"Score&Points"
score
: Score rewarded as an extra reward.points
: Points rewarded as an extra reward.voucher
: An object that defines the rewarded voucher."voucher":
{
"voucherType":"Free Product",
"productId":"6161866621123",
"productName":"Antique Drawers",
"value":250
}
rewardEvery
:
Defines the frequency upon which the referring player is rewardedrewardType
: Defines the type of the reward, possible values are: "Vouchers"
"Score&Points"
score
: Score rewarded as an extra reward.points
: Points rewarded as an extra reward.voucher
: An object that defines the rewarded voucher.friendReward
referralMethod
is "PlayerAndFriend" meaning that the referred player should also be rewarded.playerReward
object excluding the extraReward
.cashback
ObjectrewardFactor
rewardFactor
defines the specific cashback percentage for the paid amount to be rewarded to your players.rewardFactor
would be 0.05amountRewardThreshold
amountRewardThreshold
is "10".rewardWalletFactor
rewardWalletFactor
is "2"rewardRankFactor
rewardRankFactor
is "2"