Promotions
This section contains information about integration with Promotions service.
Subsections of Promotions
Daily Rewards Program - Claim Daily rewards
This document contains information about claiming daily reward for programs that currently running, state Active.
Request (POST)
/gateway/promotions/drp/{version}/{brand_id}/{program_id}/claim
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| version | path | string | true | The API version to use (pagination supported in version 3.0 and above). |
| brand_id | path | string | true | The ID of the brand. |
| program_id | path | string | true | The ID of the program. |
| day | body | int | true | The Day of program to claim reward |
| comment | body | string | false | Free text |
Headers
- x-auth-token: Requred
Postman sample:
curl --location 'http://www.my_site_backend.com/gateway/drp/1.0.0/1501/cfcaa579-c563-4474-bb81-ccddc7515982/players/231632/claim' \
--header 'jwt-auth: your-token' \
--header 'Content-Type: application/json' \
--data '{
"day":6,
"comment": "test"
}'Response
Status 200
{
"status": "Success",
"data": {
"success": true,
"transaction_id": 870,
"new_balance": 300,
"amount": 200
}
}Status 400 (Missing authentication header)
{
"status": "Error",
"data": {
"errMsg": "invalid input - invalid token"
},
"message": "authentication failed",
"userFriendlyMessage": "Authentication failed"
}Daily Rewards Program - Get Player state
This document contains information about getting state for a single player for programs that currently running, state Active.
SSE Events:
DRP_STATE_CHANGED - Sent when player state changes as result of login, deposit or claim
Request (GET)
/gateway/promotions/drp/{version}/{brand_id}/player/state
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| version | path | string | true | The API version to use (pagination supported in version 3.0 and above). |
| brand_id | path | string | true | The ID of the brand. |
| page | query | string | false | page number, starts from page 1, set to 1 if not sent |
| page_size | query | string | false | limits number of results per page, set to 100 if not sent |
- Currrently we support only for single program runniig at particular dates range
Headers
- x-auth-token: Requred
Postman sample:
curl --location 'http://www.my_site_backend.com/gateway/drp/1.0.0/1501/player/state?page=1&page_size=10' \
--header 'jwt-auth: your-token'Response
| Name | Type | Description |
|---|---|---|
| playerState | array | Array of player states per currently running programs |
| playerState -> program | object | Program information |
| playerState -> daily_progress | object | Information per day about player’s activity |
| program_progress -> day | object | Information about single day |
| … “day_value”: “100”, | Reward value | |
| … “type”: “gcoins”, | Reward type. Currently “gcoins” only. If empty - no reward for particular day of program is granted | |
| … “name”: “Day 1”, | Label defined in CBO | |
| … “transaction_id”: null, | Non-empty if reward is claimed | |
| … “updated_at”: “”, | Date when action (LOGIN) is taken by player | |
| … “claimed_at”: “”, | Non-empty if reward is claimed | |
| … “day_number”: 4 | number | Actual program day when login was made |
| … “status_code”: 0, | 0 - Eligible, 1 - Not Eligible, 2 - Future, 3 - Out od range | |
| … info_codes: [1,2] | Array of info codes/error codes | |
| … “history_info”: [] | array | Info why this day is moved vs programs days, if its moved |
| infoCodes | object | Daily information codes map |
- When player logged in the current day in “program_progress” may be detected by “status_code”, 0 - Eligible, 1 - Not eligible. “updated_at” field should contain value of last login date.
- When “day_number” is different than “program_progress” key, i.e. “program_progress[“1”] has value of “day_number”: 2 - means this is the first day when player has login but second day of actual program from start date.
Status 200
{
"status": "Success",
"data": {
"playerState": [
{
"id": "696f3e62b069bf59006708e7",
"program": {
"start_date": "2026-01-19 00:00:00",
"end_date": "2026-01-31 23:59:59",
"program_id": "d4e14eea-2029-410a-81d3-4e83f066f229",
"program_name": "Test",
"rules": {
"PlayerDepositDays": {
"value": 3
}
},
"state": "Active"
},
"brand_id": 1501,
"player_id": "231632",
"program_progress": {
"1": {
"day_value": "10",
"type": "gcoins",
"name": "Day 1",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 7,
"status_code": 1,
"info_codes": [
100,
101
],
"history_info": [
{
"date": "2026-01-19",
"info_codes": [
100,
101
]
},
{
"date": "2026-01-20",
"info_codes": [
100
]
},
{
"date": "2026-01-21",
"info_codes": [
100,
101
]
},
{
"date": "2026-01-22",
"info_codes": [
100
]
},
{
"date": "2026-01-23",
"info_codes": [
100,
101
]
},
{
"date": "2026-01-24",
"info_codes": [
100,
101
]
}
]
},
"2": {
"day_value": "20",
"type": "gcoins",
"name": "Day 2",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"3": {
"day_value": "30",
"type": "gcoins",
"name": "Day 3",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"4": {
"day_value": "40",
"type": "gcoins",
"name": "Day 4",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"5": {
"day_value": "50",
"type": "gcoins",
"name": "Day 5",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"6": {
"day_value": "60",
"type": "gcoins",
"name": "Day 6",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"7": {
"day_value": "70",
"type": "gcoins",
"name": "Day 7",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 2,
"info_codes": [
100
],
"history_info": null
},
"8": {
"day_value": "80",
"type": "gcoins",
"name": "Day 8",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"9": {
"day_value": "90",
"type": "gcoins",
"name": "Day 9",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"10": {
"day_value": "100",
"type": "gcoins",
"name": "Day 10",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"11": {
"day_value": "110",
"type": "gcoins",
"name": "Day 11",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"12": {
"day_value": "120",
"type": "gcoins",
"name": "Day 12",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"13": {
"day_value": "130",
"type": "gcoins",
"name": "Day 13",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
}
},
"created_at": "2026-01-20 08:35:46",
"updated_at": "2026-01-22 10:44:38",
"metadata": null
},
{
"id": "69665fb84a1fd41c3f8df572",
"program": {
"start_date": "2026-01-12 00:00:00",
"end_date": "2026-01-19 23:59:59",
"program_id": "97a7f04a-8e97-4583-9030-7afe3b33f3be",
"program_name": "DO NOT DELETE",
"rules": {
"PlayerDepositDays": {
"value": 3
}
},
"state": "Archived"
},
"brand_id": 1501,
"player_id": "231632",
"program_progress": {
"1": {
"day_value": "20",
"type": "gcoins",
"name": "Day 1",
"transaction_id": "",
"updated_at": "2026-01-12 14:37:54",
"claimed_at": "",
"day_number": 2,
"status_code": 0,
"info_codes": null,
"history_info": [
{
"date": "2026-01-12",
"info_codes": [
100,
101
]
}
]
},
"2": {
"day_value": "30",
"type": "gcoins",
"name": "Day 2",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 8,
"status_code": 1,
"info_codes": [
100,
101
],
"history_info": [
{
"date": "2026-01-14",
"info_codes": [
101
]
},
{
"date": "2026-01-15",
"info_codes": [
101
]
},
{
"date": "2026-01-16",
"info_codes": [
101
]
},
{
"date": "2026-01-17",
"info_codes": [
100,
101
]
},
{
"date": "2026-01-18",
"info_codes": [
100,
101
]
}
]
},
"3": {
"day_value": "40",
"type": "gcoins",
"name": "Day 3",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": null,
"history_info": null
},
"4": {
"day_value": "50",
"type": "gcoins",
"name": "Day 4",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": null,
"history_info": null
},
"5": {
"day_value": "60",
"type": "gcoins",
"name": "Day 5",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": null,
"history_info": null
},
"6": {
"day_value": "70",
"type": "gcoins",
"name": "Day 6",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"7": {
"day_value": "80",
"type": "gcoins",
"name": "Day 7",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
},
"8": {
"day_value": "100",
"type": "gcoins",
"name": "Day 8",
"transaction_id": "",
"updated_at": "",
"claimed_at": "",
"day_number": 0,
"status_code": 3,
"info_codes": [
100
],
"history_info": null
}
},
"created_at": "2026-01-13 15:07:36",
"updated_at": "2026-01-13 15:07:36",
"metadata": {
"last_deposit_date": "2026-01-13 16:04:29"
}
}
],
"total": 2,
"page": 1,
"pageSize": 100,
"infoCodes": {
"0": "Success",
"100": "player deposit is required",
"101": "player login/action is required"
}
}
}Status 400 (Missing authentication header)
{
"status": "Error",
"data": {
"errMsg": "invalid input - invalid token"
},
"message": "authentication failed",
"userFriendlyMessage": "Authentication failed"
}