Jackpot

Jackpot

Groove Gaming sends this request as a Result call when the player wins a jackpot. Idempotency must be provided, which means the same request should only be processed once. If a request is duplicated, the original response must be sent with status 200, Success - duplicate request status.

Request Parameters

Parameter Data Type Mandatory Description
accountid String(60) [0-9a-zA-Z] Required Account ID
Example: 5179068
amount Decimal (32,10) Required The jackpot win amount
Example: 2000
apiversion String Required The API version that will be used
Example: 1.2
gameid String Required Groove game ID
Note: Can contain letters and special characters
Example: 80102, game_123, slot-abc
gamesessionid String(64) Required The game session id from the start game
Example: 11_99d71938-c2d9-4844-b950-d598c2es
gamestatus String Required Game Status
Valid values: completed, pending
request String Required Request method name
Example: jackpot
roundid String(255) Required Round ID
Example: 802d1812c32686748f2afbcacfcc82114cf
transactionid String(255) Required Transaction ID
Example: 7617edd0924c11e7abb2865556898ad0

Request Example

/groove?request=jackpot&gamesessionid=123_jdhdujdk&accountid=111&device=desktop&gameid=80102&apiversion=1.2&amount=2000.0&roundid=nc8n4nd87&transactionid=trx_id&gamestatus=completed

Response Parameters

Parameter Data Type Mandatory Description
apiversion String Required The version of the API being used
Example: 1.2
balance Decimal (32,10) Required The total balance amount after the jackpot
Examples: 500, 140.25
bonus_balance Decimal (32,10) Optional The player’s bonus balance
Example: 50.0
bonusWin Decimal (32,10) Required The bonus amount won from jackpot
If casino doesn’t work with bonuses, value must be 0
code Integer Required Response code
Example: 200
game_mode Integer Optional* Combined real and bonus modes
1 = Real mode
2 = Bonus mode
*Required for CMA-compliant games
order String Optional* The type of order
Valid values: cash_money, bonus_money
*Required for CMA-compliant games
real_balance Decimal (32,10) Required The player’s real balance
Example: 100.0
realmoneyWin Decimal (32,10) Required The real money amount won from jackpot
status String Required The status of the response
Example: Success
walletTx String(50) Required The wallet transaction ID
Example: de73550e-0612-4a1b-8a0d-a5a3745b
Warning

The sum of `bonusWin` and `realmoneyWin` must equal the `amount` sent by the provider.

Response Example

Success Response

{
    "code": 200,
    "status": "Success",
    "walletTx": "aaaaaaa",
    "balance": 2100,
    "bonusWin": 0,
    "realMoneyWin": 2000,
    "bonus_balance": 50,
    "real_balance": 2050,
    "game_mode": 1,
    "order": "cash_money, bonus_money",
    "apiversion": "1.2"
}

Error Codes

Code Status Message
1 Technical error Technical error
110 Operation not allowed Reasons include:
• The result amount is less than 0
• A user with the specified accountId cannot be found
• Game status is not pending or completed
400 Transaction operator mismatch Transaction operator mismatch