Use this endpoint to terminate an in-progress bonus call before it finishes naturally. Canceling a bonus forfeits any remaining free spins or guaranteed win amount that has not yet been paid out. You can only cancel a bonus that is currently active — attempting to cancel one that has already ended returns a BONUSCALL_ALEADY_ENDED error.
Request
Endpoint: POST /v1/bonus-call/cancel
Headers
| Name | Value |
|---|
Authorization | Bearer <API_TOKEN> |
Content-Type | application/json |
Accept | application/json |
Request body
The unique identifier of the player.
The unique identifier of the bonus call to cancel, as returned by the Register Bonus endpoint.
Example request
curl --request POST \
--url https://api.igamingace.com/v1/bonus-call/cancel \
--header 'Authorization: Bearer <API_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"playerId": "player_88888",
"issueId": 9887
}'
Cancellation is irreversible. Any free spins not yet played or any guaranteed win amount not yet awarded will be forfeited. Confirm with the player before canceling on their behalf.
Bonus lifecycle
A bonus call moves through the following states:
| Status | Description | Can be canceled? |
|---|
| Active | The bonus is registered and waiting to be triggered, or currently in progress. | Yes |
| Completed | All spins have been played or the guaranteed amount has been paid out. | No — returns BONUSCALL_ALEADY_ENDED |
If you attempt to cancel a bonus that has already completed, the API returns an error with the code BONUSCALL_ALEADY_ENDED.
Response
true when the bonus was successfully canceled.
A short confirmation string, typically "OK".
Example response
{
"success": true,
"message": "OK"
}