Phoenix Prediction Docs

Player Buttons

Hide the deposit or profile button for some players with the launch token

Some choices differ per player, and must not be changeable by the player. Those ride in the signed launch token's cfg claim: only your backend can sign it, so a player cannot edit it the way they could edit an iframe URL.

Settings

cfg keyEffect when falseDefault
depositThe embed shows no Deposit button: not in the header, not on the order ticket, not in PortfolioShown
profileThe embed shows no profile or account button: not the account picture in the header, not the Account item in the phone's menuShown

Leave cfg out, or leave a key out, to show the button.

{
  "iss": "acme",
  "env": "prod",
  "sub": "operator-player-123",
  "currency": "KES",
  "name": "Player Name",
  "avatar": { "kind": "none" },
  "cfg": { "deposit": false },
  "iat": 1779100000,
  "exp": 1779100600
}

For example, hide Deposit for a player whose account cannot take deposits right now, or when your own page already shows a deposit button next to the embed.

Combined With the Header

Your look decides which parts the header carries, for every player. cfg then hides more for one player. It can never show what the look hides.

Header part in the lookcfgThe player sees
Deposit ondeposit left out, or trueThe Deposit button in the header
Deposit ondeposit: falseNo Deposit button in the header
Deposit offAnyNo Deposit button in the header
Account onprofile left out, or trueThe account picture (desktop), the Account item in the phone's menu
Account onprofile: falseNo account picture on a desktop, no Account item in the phone's menu
Account offAnyNo account picture, and no phone menu
  • The look's Deposit part is only the header's button. deposit: false also hides the Deposit prompts on the order ticket and in Portfolio, and the look's Deposit part does not.
  • With the Account part on and profile: false, a phone still has the account menu, with the player's name, Saved and (if that part is on) Notifications, but no Account item.
  • cfg does not change a visitor's Sign in button, which belongs to the Account part of the look.

What cfg Does Not Do

cfg decides what the embed draws, nothing more. It does not grant or block trading: whether a player may trade is decided by Phoenix (an active operator, a supported currency, a player your support team has not blocked) and by your wallet's answers. A Deposit button only asks your page to open your cashier (deposit.requested); see the Host SDK.