/
v3.0.11Get access

getBonusList

Retrieve a list of all available bonus requests with their rules, conditions and rewards

Request parameters:

NameDescriptionTypeValuesDefault
country
Country code used for global filteringstring--

Call example:

getBonusList({
  country: 'AM'
})

Response examples:

{
  code: 200,
  text: 'OK',
  success: true,
  data: [{
    id: 3,
    name: 'Test Bonus Talep',
    title: 'First Bonus Request',
    description: '<p>First Bonus Request Description</p>\n',
    typeId: 2,
    rewardTypeId: 2,
    skinBonusId: null,
    activeFrom: 1770148800,
    activeTo: 1803758400,
    supportedCurrencies: ['EUR', 'USD'],
    src: '/storage/medias/staging-web/bonus-request_1019_f770e9fe8ae3a1cfdbc16ba5fcef15b5.png',
    rules: [{
      id: 9,
      ruleId: 1,
      isDeleted: false,
      bonusRequestRuleConditions: [{
        id: 9,
        currencyId: null,
        period: 5,
        condition: '10',
        conditionOptions: null,
        isDeleted: false
      }]
    }],
    rewards: [{
      id: 3,
      currencyId: null,
      exactAmount: null,
      percentage: 50,
      percentageBasis: 2,
      percentagePeriodDays: 10,
      isDeleted: false,
      maxAmount: null
    }]
  }]
}

Response parameters:

NameDescriptionTypeValues
id
Unique identifier of the bonus requestnumber-
name
Name of the bonus request rule setstring-
typeId
Type identifier of the bonus requestnumber-
rewardTypeId
Type identifier of the rewardnumber-
skinBonusId
Associated skin bonus ID, or null if not linkednumber | null-
activeFrom
Start datetime of the bonus availability in milliseconds.number-
activeTo
End datetime of the bonus availability in milliseconds.number-
rules
List of rule objects associated with the bonus requestarray-
rules[].id
Unique identifier of the rule entrynumber-
rules[].ruleId
Reference ID of the rule typenumber-
rules[].isDeleted
Whether the rule has been soft-deletedbooleantrue / false
rules[].bonusRequestRuleConditions
List of conditions associated with the rulearray-
rules[].bonusRequestRuleConditions[].id
Unique identifier of the conditionnumber-
rules[].bonusRequestRuleConditions[].currencyId
Currency code the condition applies to (e.g. "AMD", "EUR"), or null for all currenciesstring | null-
rules[].bonusRequestRuleConditions[].period
Time period in days the condition applies to, or null if not applicablenumber | null-
rules[].bonusRequestRuleConditions[].condition
The condition value or expression (e.g. a threshold amount, boolean, or JSON array of IDs)string-
rules[].bonusRequestRuleConditions[].conditionOptions
Optional JSON-encoded additional options for the condition, or null if not setstring | null-
rules[].bonusRequestRuleConditions[].isDeleted
Whether the condition has been soft-deletedbooleantrue / false
rewards
List of reward objects associated with the bonus requestarray-
rewards[].id
Unique identifier of the reward entrynumber-
rewards[].currencyId
Currency the reward applies to, or null for all currenciesstring | null-
rewards[].exactAmount
Fixed reward amount, or null if percentage-basednumber | null-
rewards[].percentage
Reward percentage value, or null if amount-basednumber | null-
rewards[].percentageBasis
The basis on which the percentage is calculatednumber | null-
rewards[].percentagePeriodDays
Number of days used as the period for percentage calculationnumber | null-
rewards[].isDeleted
Whether the reward has been soft-deletedbooleantrue / false
title
Localized title of the bonus requeststring-
description
Localized description of the bonus requeststring-
src
Path to the primary image asset for the bonus requeststring-
supportedCurrencies
Supported currencies of bonus in ISO formatarray-