getLoyaltyInfo

Is used to retrieve the user’s loyalty program status and rules. Loyalty is a reward system where users earn points from activity and can exchange them for bonuses or currency. The call returns current loyalty points, current level, level thresholds, conversion rates, exchange limits, and available level-up bonuses.

This command requires the logged in session

Documentation

Try it now

Request parameters:

The method works without parameters

Call example:
JavaScriptReact HookFlutter

getLoyaltyInfo()

Response example:

{
  code: 0,
  rid: 1753217755,
  data: {
    result: 0,
    result_text: null,
    details: {
      LoyaltyEarnedPoints: 0,
      LoyaltyExchangedPoints: 0,
      LoyaltyLastEarnedPoints: 90.54,
      LoyaltyLevelId: 3270,
      LoyaltyPointUsagePeriod: 0,
      LoyaltyMaxExchangePoints: 0,
      LoyaltyMinExchangePoints: 0,
      LoyaltyRates: [{
        Id: 1419,
        CurrencyId: 'BTC',
        ConversionRate: 1000
      }, {
        Id: 1420,
        CurrencyId: 'ETH',
        ConversionRate: 1000
      }],
      LoyaltyLevels: [{
        Id: 3270,
        Name: '1',
        MaxPoint: 400,
        MinPoint: 0
      }, {
        Id: 3271,
        Name: '2',
        MaxPoint: 1500,
        MinPoint: 400
      }],
      LevelUpBonuses: [{
        LoyaltyLevelId: 3271,
        CurrencyId: 'FTN',
        Amount: 0.01
      }, {
        LoyaltyLevelId: 3271,
        CurrencyId: 'TUS',
        Amount: 0.03
      }]
    }
  }
}

Response parameters:

Name	Description	Type	Values

LoyaltyEarnedPoints	soon	number	-
LoyaltyExchangedPoints	soon	number	-
LoyaltyLastEarnedPoints	Number of loyalty points earned during the current period	number	-
LoyaltyLevelId	Identifier of the user’s current loyalty level.	number	-
LoyaltyPointUsagePeriod	soon	number	-
LoyaltyMaxExchangePoints	soon	number	-
LoyaltyMinExchangePoints	soon	number	-
LoyaltyRates	Defines how loyalty points can be exchanged into different currencies and the conversion rate for each currency.	array	-
└─ Id	Conversion rule ID	number	-
└─ CurrencyId	Target currency code	string	-
└─ ConversionRate	How many loyalty points equal 1 unit of currency	number	-
LoyaltyLevels	List of all available loyalty levels with their required point ranges, used to determine the user’s current level and progression to the next one	array	-
└─ Id	Loyalty level ID	number	-
└─ Name	Level name or rank	string	-
└─ MinPoint	Minimum points required to reach this level	number	-
└─ MaxPoint	Maximum points allowed within this level	number	-
LevelUpBonuses	Defines the rewards granted to a user when they reach a specific loyalty level.	array	-
└─ LoyaltyLevelId	Level at which the bonus is granted	number	-
└─ CurrencyId	Bonus currency code	string	-
└─ Amount	Bonus amount awarded upon reaching the level	number	-