Skip to main content
Call /freeSpinStatus to check the current state of a free spin grant. The response tells you how many spins were originally granted, how many the player has used, and how many remain. Use this endpoint after game sessions to keep your bonus tracking records up to date.

Endpoint

POST https://api.gitslotpark.com/freeSpinStatus
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.
freeSpinID
string
required
The unique identifier for the free spin grant, returned by /assignFreeSpin.
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 + freeSpinID.

Example request

{
  "apiToken": "your_api_token",
  "agentID": "Partner01",
  "freeSpinID": "fs_abc12345",
  "sign": "E5F6G7H8..."
}

Response fields

result
integer
required
Result code. 0 indicates success; any other value indicates an error. See result codes below.
status
string
Current state of the free spin grant. One of "active", "completed", or "expired". Present when result is 0.
totalSpins
integer
Total number of free spins originally granted. Present when result is 0.
usedSpins
integer
Number of free spins the player has already used. Present when result is 0.
remainingSpins
integer
Number of free spins still available to the player. Present when result is 0.
message
string
Human-readable error description. Present when result is not 0.

Example success response (in progress)

{
  "result": 0,
  "status": "active",
  "totalSpins": 20,
  "usedSpins": 7,
  "remainingSpins": 13
}

Example success response (completed)

{
  "result": 0,
  "status": "completed",
  "totalSpins": 20,
  "usedSpins": 20,
  "remainingSpins": 0
}

Example error response (not found)

{
  "result": 8,
  "message": "Free spin grant not found"
}

Status values

StatusDescription
activeThe player still has free spins remaining and can continue using them.
completedAll free spins have been used; the grant is fully consumed.
expiredThe grant reached its expiry time before all spins were used.

Result codes

CodeMeaning
0Success
1General error
2Wrong input parameters
3Invalid sign
4Invalid agent
7Invalid API token
8Free spin grant not found

Notes

Poll this endpoint after each game session to update your bonus tracking records. This ensures your system accurately reflects the player’s remaining spins without waiting for callback events.
You obtain the freeSpinID when you call /assignFreeSpin. If you did not store it at grant time, you will not be able to query the status of that bonus.