Headless Tournaments Backend Integration
Basic Concepts (Property Descriptions)
Buy In Amount: Is the amount of money a customer needs to pay to join the tournament.
Total Collected: Is the total amount of money collected. ( Number of Users * Buy In Amount )
Total Balance: Is the end result of all the money collected minus all the money rewarded to users.
Type: Currently there are 2 types of tournament rewards available:
CASH_FIXED: Fixed cash rewards that don’t change regardless of how many users join the tournament
CASH_PERCENTAGE: Percentage based rewards distribute a percentage of the new pool available to each tier, thus it relies on how many users join the tournament to get reward value
Title: Title or Name of the Tournament
Description: Description text to store a longer detailed description of the tournament.
Max Participants: Is the max number of participants allowed to join the tournament. If not provided, the system will infer the max number of participants based on the compliance limit set for the max reward allowed (this only applies to Percentage Based Rewards)
Max Attempts: Set this value to the number of attempts a player can have per tournament, the value is 1 by default
Min Payout Amount: Is an optional number used in Percentage Based Rewards to ensure a min Pool Net Amount before rewards.
Fee: Is a percentage used in Percentage Based Rewards to deduct a fee from the Total Collected before distributing the rewards.
Pool Net Amount: In Percentage Based Rewards, this is the amount to be distributed amongst the different reward tiers. It’s the greatest number between the MinPayoutAmount and the Total Collected minus the applied fee. ( PoolNetAmount = GREATEST( ( TC - ( TC * Fee % ) ) , MinPayout ) )
Pool Net Amount, Fee and MinPayoutAmount are ignored in CASH_FIXED type of tournaments since by the nature of the reward they have no impact, that's why they are optional.
Scoring Type: If type selected is HIGHEST_SCORE then users will be ranked first if they have the highest score and if type selected is LOWEST_SCORE then users will be ranked first if they have the lowest score (for example Golf scoring)
Game ID: Id of the type of game the tournament represents
Location Ids: IDs of physical location (used to filter tournaments by location). If no locations are set, that means the tournament is available in ALL locations
Created At: Timestamp of when the tournament was created.
Expires At: Timestamp of when the tournament will expire (not allow more joins).
Starts At: Timestamp of when the tournament starts (it won't accept scores until after this time)
Is Public: This boolean represents if the tournament is public or private one.
Private Code: This is the private code users need to provide to gain visibility on a private tournament
Metadata String: JSON string to store extra data at both the header level and at the user score level
Position: Position of the user in the ranking / leaderboard
Position Override: Value used to display a different value on the ranking. Used for example to display tied positions, you can override a 3 rd place as 2 to show a tie between position 2 and 3
Can Submit New Score: Boolean value to determine if the user can submit a new score
Last updated