Skip to main content
Use GetBalance to retrieve a player’s current rewards balance and withdrawal limit from your game client — both come back in a single call. A player’s withdrawal limit is how much of their balance they can withdraw right now. It grows automatically as they play, on the reward schedule configured for your app, and you can raise it from your server based on revenue events — see Withdrawal Limits (Server).
Use this before sending rewards to avoid crediting more than the player can currently withdraw. If a player’s rewards balance exceeds their withdrawal limit, the excess carries forward — they can access it as the limit grows through continued play or a server-side increase. How much the limit can grow in a day is capped, and that daily allowance resets every 24 hours. See Reward Economics for guidance on configuring withdrawal limits.
The maintenance flag can return true at any point, including mid-session. When active, do not update the displayed balance. See Error Handling for full maintenance mode guidance.
To react in your game when a player completes a withdrawal — refreshing this balance, celebrating, or logging the cashout — subscribe to Withdrawal Events.