Crediting the player's winnings

Overview

Request type	URL
POST	<server-partner>/win

This method allows to credit the player's winnings.

Notice

The request is executed by the provider.

Parameters

Request

Optional fields are excluded from hash calculations.
Optional* fields are included in hash calculations only if they are provided.

Name	Type		Description
amount	string		Transaction amount
currency	string		The currency in which the game will be played
partnerId	bigint		Unique partner identifier
playerId	string		Unique player identifier in the partner’s system
gameId	bigint		Unique identifier of the game
roundId	bigint		Unique identifier of the betting round
betTransactionId	bigint		Unique identifier of the betting transaction in the partner's system
transactionId	bigint		Unique identifier of the provider's winning transaction
sessionId	string	optional*	Unique game session identifier in the partner's system
hash	string		Signature (sha256 from encryption string)
finished	boolean	optional	Flag indicating whether the round is finished

If /bet/win per free spin setting is applied:

isFreespinWin	boolean	optional	Flag indicating if the round was played within a freespin campaign
campaignExtId	string	optional	Unique identifier of the campaign in the partner’s system
leftSpins	bigint	optional	Amount of freespin rounds still available to the player after the current round has been played
spinCount	bigint	optional	Total number of freespin rounds
currentSpins	bigint	optional	Number of freespin rounds that have already been played

String to hash

"win" + amount + currency + partnerId + playerId + gameId + roundId + betTransactionId + transactionId + sessionId* + apiKey

Response

Name	Type	Description
balance	string	Player's current balance
transactionId	string	Unique identifier of the winning transaction in the partner’s system

Example

Request

{  
    amount: '20.00',  
    currency: 'USD',  
    partnerId: 1,  
    playerId: '432',  
    gameId: 3,  
    roundId: 7665,  
    betTransactionId: 1333882827,  
    transactionId: 36,  
    sessionId: '123',  
    finished: true,  
    hash: 'd919a11d4cb1b0dc4cc0d5f880c6970fd160d434b3a779a66a9a7f6451d108fd'  
}

Response

{  
    status: 'success'  
    data: {  
        balance: '10123.63',   
        transactionId: '1333882829'  
    }  
}

Errors

Possible error messages:

Message	Description
RequiredParamsNotFound	Incorrect number of parameters in the request
InvalidParamType	Incorrect parameter type
CurrencyNotFound	Currency with such code not found
IncorrectHash	Incorrectly calculated hash
ServerError	Server error