Skip to main content
Call /assignFreeSpin to grant a player a number of free spins on a specific game. Free spins are bonus rounds where the player does not wager their own balance — GitSlotPark covers the stake. Once granted, the player launches the target game and the free spins are applied automatically. Save the freeSpinID returned in the response so you can track the bonus progress with /freeSpinStatus.

Endpoint

POST https://api.gitslotpark.com/assignFreeSpin
Replace https://api.gitslotpark.com with the base URL provided to you by GitSlotPark.

Request parameters

apiToken
string
required
Your API token provided by GitSlotPark.
agentID
string
required
Your Partner ID assigned by GitSlotPark.
userID
string
required
The player’s ID in your system.
gameID
string
required
The target game for the free spins. Use a gameID returned by /gameList.
spinCount
integer
required
The number of free spins to grant to the player.
sign
string
required
HMAC-SHA-256 signature of the concatenated request parameters using your secret key, expressed as an uppercase hex string. For this endpoint the signature input is: agentID + userID + gameID + spinCount.

Example request

{
  "apiToken": "your_api_token",
  "agentID": "Partner01",
  "userID": "player_12345",
  "gameID": "slot_001",
  "spinCount": 20,
  "sign": "A1B2C3D4..."
}

Response fields

result
integer
required
Result code. 0 indicates success; any other value indicates an error. See result codes below.
freeSpinID
string
Unique identifier for this free spin grant. Present when result is 0. Pass this value to /freeSpinStatus to check how many spins the player has used.
message
string
Human-readable error description. Present when result is not 0.

Example success response

{
  "result": 0,
  "freeSpinID": "fs_abc12345"
}

Example error response (invalid game)

{
  "result": 2,
  "message": "Invalid gameID"
}

Result codes

CodeMeaning
0Success
1General error
2Wrong input parameters
3Invalid sign
4Invalid agent
7Invalid API token

Notes

Save the freeSpinID from a successful response. You will need it to call /freeSpinStatus and check the player’s remaining spins.
Free spins are tied to a specific game. The player must launch the game identified by gameID to use them. Spins cannot be transferred to another game after granting.
When a player uses their free spins, GitSlotPark will call your Withdraw/BetWin callback with a freeSpin flag set. Use this flag to record free spin transactions separately from real-money wagers in your system.