Skip to main content

Reward process status flow

The Reward Processor manages the complete lifecycle of player rewards β€” from creation and claiming to activation and expiration. The reward claiming process can be initiated in two ways: either through the user interface (UI) or by an administrator, both with the goal of awarding a reward to the player. Rewards can also be automatically granted through other gamification products such as Missions, Tournaments, Campaigns, or purchased directly by the player through the Reward Shop. When a claim is initiated, the system first checks whether the reward has already been claimed. If it has, the process ends there. If the reward is still available (Unclaimed), the process continues depending on its type and activation configuration.

🎁 Types of Rewards​

Each reward type has its own logic during activation and claiming:

Reward TypeDescription
Bonus OfferSends a promotional bonus to the player through the external Bonus System.
Tokens / XPGrants virtual tokens or experience points directly to the player's account.
Boosters (Level, Mission, Token)Temporarily multiply the player's progress or points. They may activate automatically or manually.
MiniGameUnlocks special interactive mini-game rewards.
ExternalRewards from external systems, directly marked as Granted.
ManualRewards manually created and assigned by administrators.

πŸ”„ Reward Lifecycle​

Rewards move through several stages to ensure full traceability and reliability:

StatusDescription
UnclaimedThe reward is available but has not yet been claimed by the player.
PendingBooster-type/Mini-Games rewards waiting to be activated.
In ProgressReward activation is ongoing.
Granted / CompletedThe reward was successfully delivered or used by the player.
FailedAn error occurred while processing the reward.
Declined / Deleted / Expired / BouncedThe reward was declined, removed, expired, or abandoned (e.g., mini-games).

βš™οΈ Claiming and Activation Flow​

The reward claiming process can be initiated in two ways: either through the user interface (UI) or by an administrator, both with the goal of awarding a reward to the player. Rewards can also be automatically granted through other gamification products such as Missions, Tournaments, Campaigns, or purchased directly by the player through the Reward Shop.

When a claim is initiated, the system first checks whether the reward has already been claimed. If it has, the process ends there. If the reward is still available (Unclaimed), the process continues depending on its type and configuration.

Once validated, the system determines the type of reward and executes the appropriate flow:

  • Automatic rewards are activated immediately after being created.
  • Manual or player-activated rewards remain in Unclaimed or Pending status until the player or administrator triggers activation.
  • Once activation starts, the reward transitions to In Progress and then to Granted or Completed depending on the result.
  • If any error occurs during the process, the status changes to Failed, providing traceability for support and debugging.

This ensures that all rewards β€” whether earned, purchased, or manually granted β€” follow a consistent, transparent, and reliable process from creation to delivery.

Docusaurus themed imageDocusaurus themed image

🎯 Reward Processor (RP) – User Journey Overview​

The Reward Processor (RP) manages the complete reward lifecycle β€” from creation to delivery β€” based on platform configuration.

Each reward goes through a set of statuses that describe its current state in the process.

How the reward moves between these statuses depends on two main configuration flags:

  • PlayerShouldClaimRewards – determines if the player must manually claim the reward.
  • AutomaticActivation – determines if the reward is automatically activated or needs manual activation.

🧭 User Journey Scenarios​

Scenario 1 – Player Must Claim and Activate​

Actors: πŸ‘€ Player β†’ βš™οΈ Reward Processor (RP) β†’ 🧩 Mechanic or service
(Typical for boosters, mini-games, or rewards with expiration)

  1. A new reward is registered in RP.
  2. Since PlayerShouldClaimRewards = true, the reward is stored in the Chest β†’ status: Unclaimed.
  3. The player clicks Claim in the widget β†’ status: Pending Activation.
  4. The player then clicks Activate β†’ RP validates expiration date.
  5. If the reward expires before activation β†’ status: Expired.
  6. If valid β†’ reward moves to In Progress and is delivered to the corresponding mechanic (e.g., Missions, Ranks).
  7. The service processes the reward:
    • Applies effects (XP, multipliers, etc.)
    • Reports completion β†’ status: Granted or Complete.
  8. If any delivery error occurs β†’ status: Failed.

Scenario 2 – Automatic Activation​

(Typical for XP, Tokens, Bonus, External rewards)

  1. A new reward is registered.
  2. Since PlayerShouldClaimRewards = false, the reward goes directly to Pending Activation.
  3. If the reward expires before activation β†’ status: Expired.
  4. If AutomaticActivation = true, the RP immediately delivers the reward to the mechanic.
  5. Reward moves to In Progress, and after successful delivery β†’ Granted.
  6. If there’s a communication or system error β†’ Failed.

🧩 Status Table​

StatusSet WhenWho Triggers ItDescription
UnclaimedReward created and stored in chestRPPlayer must claim before activation.
Pending ActivationPlayer claims the reward or system schedules activationRPWaiting to be activated or automatically delivered.
In ProgressReward delivery startedRP β†’ MechanicMechanic is processing or validating reward (XP, mission, bonus, etc.).
GrantedReward successfully appliedMechanic β†’ RPReward applied to player (e.g., XP added, bonus granted).
CompleteTemporary reward finishedMechanic β†’ RPBooster or timed reward expired after use.
ExpiredReward validity period ended before activationRPReward is no longer valid.
FailedDelivery or communication error occurredRPMechanic could not process reward; flagged for retry or support.
DeclinedPlayer rejects the rewardPlayerReward is canceled and not stored.

🎁 Reward Type Summary​

Reward TypeActivation MethodExpiresDelivered ToExample / Description
XPAutomatic❌ NoRanksPlayer receives experience points instantly; rank system updates player progress.
TokensAutomatic❌ NoWallet / Token mechanicVirtual currency or points are added automatically to the player balance.
BonusAutomatic❌ NoBonus Service / CasinoExternal casino bonus granted directly (e.g., 10 € bonus).
ExternalAutomatic❌ NoDo nothingβ€”
Mission BoosterPlayer Manualβœ… YesMissionsPlayer activates a booster (e.g., Γ—2 contribution) valid for a set period (e.g., 3 hours).
Token BoosterPlayer Manualβœ… YesTokensMultiplies earned tokens for a time window (e.g., Γ—3 tokens for 1 hour).
Level BoosterPlayer Manualβœ… YesRanksTemporarily increases XP gain in rank progression.
Mini-GamePlayer Manualβœ… YesMini-Game MechanicUnlocks a game that must be played before expiration (e.g., spin-the-wheel).
Manual RewardAdmin Manual❌ NoDefined by AdminAdministrator assigns reward directly to player.

βœ… Quick Summary​

  • Automatic rewards: delivered immediately β€” no user action.
    (XP, Tokens, Bonus, External)

  • Manual rewards: require player activation, may expire.
    (Mission Booster, Token Booster, Level Booster, Mini-Game)