Skip to main content
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

Request body

string
required
The unique identifier of the player.
long
required
The unique identifier of the bonus call to cancel, as returned by the Register Bonus endpoint.

Example request

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: If you attempt to cancel a bonus that has already completed, the API returns an error with the code BONUSCALL_ALEADY_ENDED.

Response

boolean
true when the bonus was successfully canceled.
string
A short confirmation string, typically "OK".

Example response