/
v3.0.11Get access

getFreeSpinBonuses

This command retrieves a detailed list of Free Spin rewards associated with a player's account

Request parameters:

NameDescriptionTypeValuesDefault
maxRows
Specifies the maximum number of bonus records to return in a single responsenumber--
skipRows
The number of records to skip from the start of the listnumber--
clientBonusId
A filter used to retrieve information for one specific bonus instance. If provided, the response will be narrowed down to only this unique ID. Id can be received from getFreeSpinBonuses api under 'Id'.number--
acceptanceType
Filters bonuses by their claim status string"availableBonus", "accepted", "activated"-
This method is usually used with these methods:

Call example:

getFreeSpinBonuses({
  maxRows: 10,
  skipRows: 0,
  clientBonusId: 215144151,
  acceptanceType: 'availableBonus'
})

Response examples:

{
  code: 0,
  rid: '163903273311019',
  data: {
    result: 0,
    result_text: null,
    details: [{
      Id: 111136524,
      PartnerBonusId: 85912,
      Source: 2,
      Name: 'Test 2 Wazdan FreeSpin AA',
      Description: 'Test 2 Wazdan FreeSpin AA\nLorem Ipsum is simply dummy text of the printing and typesetting industry...',
      StartDate: 1637235780,
      EndDate: 1700395980,
      ClientBonusExpirationDate: 1701677580,
      ExpirationDate: 1701677580,
      ExpirationDays: null,
      WageringFactor: 0,
      DepositWageringFactor: 0,
      MoneyRequirenments: null,
      CanAccept: false,
      IsForVerifiedPlayersOnly: null,
      BonusType: 5,
      Amount: 4,
      AcceptanceType: 0,
      ResultType: 0,
      ExternalId: 63074,
      AmountPercent: null
    }]
  }
}

Response parameters:

NameDescriptionTypeValues
Id
Unique identifier for this bonus instance assigned to the clientnumber-
PartnerBonusId
Reference ID to the partner's bonus template/configurationnumber-
Source
Soonnumber-
Name
Display name of the bonus promotionstring-
Description
Full description with terms, conditions, and promotional textstring-
StartDate
Unix timestamp (seconds) when bonus becomes availablenumber-
EndDate
Unix timestamp when the bonus offer expiresnumber-
ClientBonusExpirationDate
Unix timestamp when the client must use claimed free spins bynumber-
ExpirationDate
Soonstring-
WageringFactor
Soonnumber-
DepositWageringFactor
Soonnumber-
MoneyRequirenments
Soonstring-
CanAccept
Soonbooleantrue / false
IsForVerifiedPlayersOnly
Soonbooleantrue / false
BonusType
Bonus type identifiernumber-
Amount
Number of free spins grantednumber-
AcceptanceType
Claim statusnumber-
ResultType
Soonnumber-
ExternalId
Soonnumber-
AmountPercent
Soonnumber-