Reward - Cancel

This section contains endpoints used to cancel assigned rewards.

---

Cancel

Cancels a specific reward identified by id or externalId.

POST /api/v1/integration/rewards/cancel

Request

Parameter	Type	Description	Required
id	UUID	Reward identifier	Conditional
externalId	String	Merchant-defined reward identifier	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": "6d181739-a4c4-4932-a3de-0a980bfee707",
  "merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
  "timestamp": 1754495931035,
  "hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}

Response

200 OK

No response body is returned.

---

Bulk Cancel

Cancels multiple rewards identified by their ids or externalIds.

POST /api/v1/integration/rewards/bulkCancel

Request

Parameter	Type	Description	Required
ids	Array<UUID>	List of reward identifiers	Conditional
externalIds	Array<String>	List of merchant-defined reward identifiers	Conditional
merchantId	UUID	Merchant identifier	Yes
timestamp	Long	UNIX timestamp in milliseconds	Yes
hash	String	HMAC SHA256 signature used to verify request	Yes

Example Request

{
  "ids": ["6d181739-a4c4-4932-a3de-0a980bfee707"],
  "merchantId": "1387a6cc-3651-4473-ae52-e415caea3395",
  "timestamp": 1754495931035,
  "hash": "e93556d37a8c4eab7bda2d411322cdc4f0dc444c9101d9453a6635dfd8c73f7d"
}

Response

200 OK

No response body is returned.

---

Bulk Cancel By Query

Cancels multiple rewards identified by their ids or externalIds.

POST /api/v1/integration/rewards/bulkCancelByQuery

Request

Parameter	Type	Description	Required
playerIds	List<String>	List of Player identifiers	Yes
rewardConfigurationId	UUID	Reward configuration identifier	No
externalRewardConfigurationId	String	Merchant-defined reward configuration identifier	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

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

Response

200 OK

No response body is returned.