Reward Configuration - Read
This section contains endpoints used to retrieve reward configurations.
Read
Retrieves a specific reward configuration.
POST /api/v1/integration/reward-configurations/read
Request
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | UUID | Reward configuration identifier | Conditional |
| externalId | String | Merchant-defined identifier used to reference the reward configuration | Conditional |
| merchantId | UUID | Merchant identifier | Yes |
| timestamp | Long | UNIX timestamp in milliseconds | Yes |
| hash | String | HMAC SHA256 signature used to verify the request | Yes |
Example Request
{
"id": "7a899322-c001-4187-8a8b-26d51d0e08fd",
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"timestamp": 1754495931035,
"hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}
Response
200 OK
Example Response
{
"id": "7a899322-c001-4187-8a8b-26d51d0e08fd",
"name": "Free Bet Promo",
"status": "ACTIVE",
"rewardType": "FREE_BET",
"numberOfFreeBets": 2,
"startDate": 1754495931035,
"endDate": 1757097931035,
"duration": 60,
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"games": [
{
"id": "f72cb8ef-10e6-4903-8735-369f6544a0a2",
"gameId": 1,
"betConstraints": {
"EUR": {
"betAmount": 1,
"maxWinPerBet": 100
}
}
}
]
}
Read All
Retrieves all reward configurations that match the provided filters.
POST /api/v1/integration/reward-configurations/readAll
Request
| Parameter | Type | Description | Required |
|---|---|---|---|
| name | String | Reward configuration name (partial match) | No |
| status | String | Reward configuration status [ACTIVE, INACTIVE] | No |
| rewardType | String | Reward type [FREE_BET] | No |
| merchantId | UUID | Merchant identifier | Yes |
| timestamp | Long | UNIX timestamp in milliseconds | Yes |
| hash | String | HMAC SHA256 signature used to verify the request | Yes |
Example Request
{
"name": "Promo",
"status": "ACTIVE",
"rewardType": "FREE_BET",
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"timestamp": 1754495931035,
"hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}
Response
200 OK
Example Response
[
{
"id": "7a899322-c001-4187-8a8b-26d51d0e08fd",
"name": "Free Bet Promo",
"status": "ACTIVE",
"rewardType": "FREE_BET",
"numberOfFreeBets": 2,
"startDate": 1754495931035,
"endDate": 1757097931035,
"duration": 60,
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"games": [
{
"id": "f72cb8ef-10e6-4903-8735-369f6544a0a2",
"gameId": 1,
"betConstraints": {
"EUR": {
"betAmount": 1,
"maxWinPerBet": 100
}
}
}
]
}
]