This API request enables the operator to get the list already awarded bonuses.
BonusList() Request
Type | Input |
---|---|
HTTP Method | POST |
API URL | https://<API_BASE_URL>/wallet/bonus-list/ |
Headers | "Content-Type": "application/json" |
POST Parameters | json object e.g.: { |
Parameters | Type | Description |
---|---|---|
api_key | String | API Key allocated to each front-end |
start_date | String | Date time from which this bonus can be used. format = “YYYY-MM-DD HH:MM:SS” |
end_date | String | Expire date time of the promotion. format = “YYYY-MM-DD HH:MM:SS” |
limit_level | Integer | It should be from 1 to n. Per request, API sends only recent 400 records in the response. To get 2nd recent 400 records, its value should be 2. This is similar to pagination. |
player_id( optional ) | String | unique Id of player. If this parameter sent in request, then response will be return in player specific. |
BonusList() Response & Example
{
"result": {
"status": "success",
"headers": '[campaign_id, player_id, currency, game_ids, coin_value_level, num_rounds, state, max_win_limit, promo_start_date, promo_end_date]',
"bonus_list": [['NewYear-1', 'user123', 'USD', '[1032, 1041]', 1, 10, 'completed', 100, '2021-03-08 09:37:20', 2021-03-09 09:37:20'],
['NewYear-2', 'user123', 'USD', '[1032, 1041]', 1, 10, 'completed', 100, '2021-03-08 09:37:20', 2021-03-09 09:37:20']]
}
}
Object/Key in Response Object | Type | Description |
---|---|---|
result | JSON Object | Key result contains the JSON object as value. |
status | String | Response status |
bonus_list | Json Object | This is a list of lists. Each list has these values in order Most of the headers are self explanatory. Below are the different values possible for “state” ‘yet_to_start’ : ‘yet to play’ ‘active’: ‘Campaign is in active state’ ‘completed’: ‘campaign successfully completed’ ‘canceled’: ‘campaign canceled’ ‘expired’: ‘automated cronjob will close’ |