JRGS Casino API
ReferenceLaunch API

Cancel an award

The casino calls DELETE /free-rounds/{bonusId} on the launch API, with a key that holds the free_rounds scope.

DELETE/free-rounds/{bonusId}

Ends an active award as cancelled: its unplayed rounds are not played. A spin already started finishes and counts. Rarely, such a spin is then undone, when the RGS fails before it pays: played still counts it, but no credit comes for it. Your credits, each marked with the award, are the authority on the rounds played. An award that has already ended is answered as it is, so a repeat is safe.

Path Parameters

bonusId*string

The casino's id of the award.

Query Parameters

playerId*string

The casino's player id.

gameId*string

The award's game.

Header Parameters

X-Key-Id*string

The id of the signing key, as issued with it.

X-Timestamp*string

Unix seconds, within 60 s of the RGS clock. The first line of the signed payload.

Match^-?[0-9]+$
X-Signature*string

Base64 (standard, padded) Ed25519 signature of "{X-Timestamp}\n{METHOD}\n{path?query}\n{hex(sha256(body))}".

Formatbyte
X-Request-Id?string

Echoed as requestId in an error. One is generated when absent. On POST /sessions the body's requestId replaces it once the body has been read and signed.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/free-rounds/string?playerId=string&gameId=string" \  -H "X-Key-Id: string" \  -H "X-Timestamp: 1793707200" \  -H "X-Signature: string"
{  "bonusId": "string",  "awardId": "3f696bdd-e4bc-4a03-b01a-16da5c324b35",  "marketId": "string",  "gameId": "string",  "player": {    "id": "string",    "currency": "string"  },  "rounds": 0,  "bet": 0,  "expiresAt": "2019-08-24T14:15:22Z",  "state": "active",  "played": 0,  "remaining": 0,  "totalWin": 0}