Sport Bonus Amount¶
Overview¶
Sport bonus amount is a bonus type that requires wagering before bonus funds can be converted to cash. This integration guide covers everything you need to implement sport bonus transactions in your wallet system.
Quick Start¶
To integrate sport bonus amount, you need to:
- Understand the balance types - Learn about cash, bonus, locked, and retract balances
- Implement three transaction types - Award, Release, and Retract
- Handle bonus-qualified bets - Process regular bets and settlements with bonus fields
- Follow lifecycle rules - Handle multiple bonuses and post-completion settlements
Transaction Types¶
Sport bonus amount requires implementing three bonus-specific transaction types:
| Transaction Type | Reason | Type | Description |
|---|---|---|---|
| Bonus Award | bonus award | award | Grants bonus funds to the user |
| Bonus Release | bonus limit release | release | Converts successfully wagered bonus to cash |
| Bonus Retract | bonus release | retract | Removes bonus funds when conditions aren't met |
See: Transaction Types Reference for detailed examples and request/response formats.
Documentation Structure¶
This guide is organized into the following sections:
Understanding Balance Types¶
Learn about the four balance types used in sport bonus transactions:
- Cash Balance - Player's real money
- Bonus Balance - Bonus funds that must be wagered
- Locked Balance - Temporarily locked real money
- Retract Balance - Collected unwagered bonus funds
How Bonus Calculations Work¶
Understand the business logic behind bonus transactions:
- Key parameters (Bonus Rate, Max Bonus Release)
- Bet placement and settlement logic
- How GR8 Tech calculates
amountBreakdown - Bonus-qualified bet and settlement transactions
Transaction Types Reference¶
Detailed reference for all three bonus transaction types:
- Award Transaction - Grant bonus funds
- Release Transaction - Convert bonus to cash
- Retract Transaction - Remove bonus funds
Includes complete request examples with field descriptions.
Bonus Lifecycle and Error Handling¶
Learn about bonus lifecycle management and error handling:
- Active bonus period
- Post-completion settlements
- Multiple active bonuses
- Common error scenarios
- Request processing requirements
Flow Examples¶
Complete end-to-end examples:
- Successful bonus release flow
- Bonus retract flow
- Bet placement and settlement with bonus
Key Concepts¶
GR8 Tech Handles Calculations¶
You don't need to calculate bonus amounts yourself. GR8 Tech system:
- Tracks each campaign's bonus and locked balances separately
- Calculates all
amountBreakdownvalues based on campaign rules - Sends you ready-to-apply amounts in each transaction request
Your responsibility: Apply the received amountBreakdown to player balances and return updated balances.
Multiple Active Bonuses¶
Players can have multiple active bonus campaigns simultaneously. Each campaign is identified by:
sportBonusOfferId- The bonus campaign identifier (Activity ID from Journey Builder)sportBonusPlayerOfferId- The player's specific bonus activation identifier
Idempotency Required¶
All bonus transactions must follow the same idempotency requirements as standard wallet transactions. See PerformTransaction documentation for complete details.
Next Steps¶
- Start with Understanding Balance Types to learn the fundamentals
- Read How Bonus Calculations Work to understand the business logic
- Review Transaction Types Reference for implementation details
- Study Flow Examples to see complete scenarios
- Check Lifecycle and Error Handling for edge cases
Additional Resources¶
- General Bonus Information - Bonus system overview and setup
- Sport Bonus Balance Documentation - Detailed bonus rate calculation
- PerformTransaction API - Core wallet integration