API docs v1
Aggregator API · v1

Add Freerounds

Grant a player free rounds with an explicit stake, count, and validity period.

POST/v1/commandsaddFreeRoundsIdempotency key required
On this page

Availability#

Free rounds are available for supported PG, Pragmatic Play, and JILI slot games. Check the catalogue and provider/game support for your currency. A currency code or capability flag alone does not guarantee a grant will be accepted.

Request#

Scope: proxy:addFreeRounds or proxy:*. Send a persisted Idempotency-Key. Replace the illustrative game ID with an entitled, supported game.

json
{
  "method": "addFreeRounds",
  "gameid": "12/737",
  "freespins": 10,
  "bet_level": 1,
  "total_bet": 4,
  "valid_days": 7,
  "user_username": "player-1001",
  "currency": "USD"
}
FieldRequiredAccepted value
gameidYesCurrent catalogue identifier, up to 255 characters
user_usernameYesStable player identifier, 1–128 characters
currencyYesEntitled three-letter uppercase code with provider/game support
freespinsYesInteger from 1 to 10000
bet_levelYesInteger from 0 to 6
valid_daysYesInteger from 1 to 365
total_betNoFinite positive JSON number up to 1000000, stake per spin

Send an explicit total_bet to make the stake unambiguous. When omitted, the current connection uses max(1, bet_level) as the stake. Gateway bounds do not override narrower provider limits.

Response and settlement#

On success, error is 0 and response describes the grant, including game_id, freespins, currency, valid_until, and active. It is an acknowledgement, not a live report of consumed rounds.

Round settlements may include free_spin_bonus; preserve it as provider metadata and use credit_amount for the authoritative balance. Cancel unused rounds for the same player and game. List-all and cancel-all operations are currently unsupported.