Skip to main content

Reward - Read All

Retrieves rewards with optional filters such as playerId, rewardConfigurationId, or status.

POST /api/v1/integration/rewards/readAll


Request

ParameterTypeDescriptionRequired
playerIdStringPlayer identifierNo
rewardConfigurationIdUUIDReward configuration identifierNo
externalRewardConfigurationIdStringMerchant-defined reward configuration identifierNo
statusStringReward status [IN_PROGRESS, CLOSED, EXPIRED, CANCELLED]No
merchantIdUUIDMerchant identifierYes
timestampLongUNIX timestamp in millisecondsYes
hashStringHMAC SHA256 signature used to verify the requestYes

Example Request

{
"rewardConfigurationId": "7a899322-c001-4187-8a8b-26d51d0e08fd",
"playerId": "f72cb8ef-10e6-4903-8735-369f6544a0a2",
"status": "IN_PROGRESS",
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"timestamp": 1754495931035,
"hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}

Response

200 OK

Example Response

[
[
{
"id": "6d181739-a4c4-4932-a3de-0a980bfee707",
"rewardConfigurationId": "7a899322-c001-4187-8a8b-26d51d0e08fd",
"playerId": "f72cb8ef-10e6-4903-8735-369f6544a0a2",
"merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
"assignedDate": 1754582449050,
"expirationDate": 1754586049050,
"assignedFreeBets": 2,
"remainingFreeBets": 3,
"status": "IN_PROGRESS"
}
]
]