GrantBonus() API

This API request enables the operator to grant bonus free spins (promotional free spins) to the player.

GrantBonus() Request

Type	Input
HTTP Method	POST
API URL	https://<API_BASE_URL>/wallet/grant-bonus/
Headers	"Content-Type": "application/json"
POST Parameters	json object e.g.: { "api_key": "15OY0Rx1BC0hYbCm", "amount_type": "promo_freespin", "campaign_id": "BOn-3", "game_ids": [1032,1041], "coin_value_level": 1, "num_rounds":10, "player_ids":["267"], "currencies": ["USD"], "start_date":"2021-01-19 14:00:00", "end_date":"2021-01-30 15:00:00", "max_win_limit":0, }

Parameters	Type	Description
api_key	String	API Key allocated to each front-end
amount_type	String	Mode of the play.  Ex: ‘promo_freespin’ – It is when the player is playing with promo freespins
campaign_id	String	It should be unique campaign id
game_ids	List	List of game_id for which promo free spins are granted. Ex: game_ids: [1,10,6,3]
coin_value_level	Integer	The value must be an integer and must be from allowed list of coin values levels. Before you start with promo freespins, we will provide the list of allowed coin value levels. Ex: coin_values:[10, 10, 20, 30]
num_rounds	Integer	It indicates the number of free spin rounds that is granted to the player.
player_ids	List	Player ID of the player known to the operator. Free spins are granted to all these player IDs mentioned in this list and for all the games mentioned in the game_ids list.
currencies	List	Currency of the player and it should match with the player currency which is already registered with us. Currencies count should match with the players count. Ex:- ["EUR", "USD"]
start_date(Optional)	String	Date time from which this bonus can be used. It should not be less than are equal to current time format = “YYYY-MM-DD HH:MM:SS”
end_date	String	Expire date time of the promotion. It cannot be less than the start_date format = “YYYY-MM-DD HH:MM:SS”
max_win_limit(Optional)	Integer	This parameter is used to cap the winnings from promo free spins. We need to provide this value while granting free spins. It's value is in cents. It should be 0 when there is no cap on the winnings. For example, Player with USD currency is awarded with 10 free spins with 100 cents as cap amount. If the winnings are USD 20 from these 10 rounds, as per the cap amount, only 1 USD is credited to the player wallet. if the cap value is set a 0, entire win amount of USD 20 is credited to player wallet.

GrantBonus() API additional notes

• Combination of campaign_id, player_id and game_id is always unique per operator/aggregator.
• Coin value levels are explained below. Below are the coin values per game and per currency for reference. Actual coin values will be provided during the integration.

Country	Currency	Level 1	Level 2	Level 3	Level 4	Level 5
European Union	EUR	1	2	3	4	5
Argentina	ARS	30	60	90	120	150
Australia	AUD	1	2	3	4	5
Brazil	BRL	5	10	15	20	25
Bulgaria	BGN	1	2	3	4	5
Canada	CAD	1	2	3	4	5
China	CNY	10	20	30	40	50

• Example: For Game-1 if the coin value level 3 is chosen, coin value for EUR player would be 3, coin value for ARS player would be 90, coin value for BRL would be 15. These are the coin values that will be used during the promo free spins play.

GrantBonus() Response & Example

{
     "result": {
        "status": "success",
        "promo_freespin_id": 131
    }
}

Object/Key in Response Object	Type	Description
result	JSON Object	Key result contains the JSON object as value.
status	String	Response status
promo_freespins_id	Integer	This is providers ID.