Reference / @getenginex/sdk-igaming / LoyaltyStatus
LoyaltyStatus
The player's loyalty status (GET /loyalty).
Properties
currentPoints
currentPoints:
number
Points available for redemption (integer).
currentTier
currentTier:
string|null
Current tier; null when the gateway does not report it (empty or absent). The contract does not list the possible tiers (the operator defines them).
lifetimeDeposited
lifetimeDeposited:
number
Total deposited over the player's lifetime, in minor units (the currency does not come with it).
lifetimeWagered
lifetimeWagered:
number
Total wagered over the player's lifetime, in minor units (the contract field is called *_cents; the currency does not come with it).
pointsRedeemed
pointsRedeemed:
number
Points already redeemed (integer).
tierBenefits
tierBenefits:
Record<string,unknown> |null
Benefits of the current tier, read from the JSON text the gateway passes along. The format is defined by the operator (the contract only says "benefits of the current tier"): check before displaying. null when it comes empty or absent, and also when it is not a valid JSON object (in this case onValidationIssue is notified, without the content).
tierExpiresAt
tierExpiresAt:
string|null
When the tier expires (ISO 8601, UTC); null when the gateway does not send it.
tierPoints
tierPoints:
number
Points that count toward the tier (integer); the calculation rule is not reported by the contract.
totalPointsEarned
totalPointsEarned:
number
Total points earned (integer).