Cancel Freespins

🎁 Description

🎯 Command “cancelfs” – Cancel Freespins (Seamless Wallet)

This endpoint cancels a previously granted freespins session by marking all freespins as played, assigning no winnings that occured in the freespins session, and updating the status to reflect cancellation. Also known as command 30 in API VERSION 1.0

Upon execution:

  • The freespins session will be marked as completed (status = 0).

  • No wins from the freespins session will be credited to the user.

  • The related gameplay will also be marked as completed (status = "ok").

📜 Sample JSON Request (from your server to the RGS-CWS server)

{ "command": "cancelfs", "login": "demoaccount", "gameid": "6857", "freespins_id": "1510", "expiry_date": "2024-01-01 00:00:00" }

📥 Input Parameters (from your server to the RGS-CWS server)

Parameter

Mandatory

Description

Type

*command

✅

Must be "cancelfs"

string

*login

✅

Username (min. 6 characters). Required unless userid is used instead

string

*userid

❌

RGS-CWS user ID (used as an alternative to login, not both).

string

*gameid

✅

Game ID for which the freespins were granted. Must support freespins (check with Command 24)

string

*freespins_id

✅

Unique freespins round ID you want to cancel (obtained when you granted freespins via Command 29=grantfs)

string

⚠️ You must provide either login or userid — not both.

📃 Sample JSON Response (returned by RGS-CWS)

{ "status": "OK", "message": "Freespins successfully canceled", "freespins_id": "1510" }

📤 Output Parameters (returned by RGS-CWS)

ParameterRequiredDescriptionType

status

✅

"OK" for success or "ERROR" for failure

string

message

✅

Status explanation or error reason

string

freespins_id

✅

The freespins round ID that was cancelled

string

✅ Operator Action Required

  • Use this command only for freespins that have not yet been completed by the user.

  • Always verify that the freespins_id is valid and matches the game.

  • A canceled freespins session will mark all spins as completed with no winnings applied.

  • A cancelled freespins session will mark the gameplay id as completed (not cancelled), but the winnings from freespins will not be granted to the user. Just the winnings from main spin will remain granted, as they were granted before the freespins round began.