/
v3.0.11Get access

getFreeChipBonuses

This command is used to retrieve a list of available or active "Free Chip" type bonuses for a specific client

Request parameters:

Name
DescriptionTypeValuesDefaultSource
acceptanceType
Filters the bonuses based on their current state or how they are accepted by the playerstring"accepted", "activated", "availableBonus"--
clientBonusId
ID of the client bonusnumber--
Key from responseid
startDate
Defines the beginning of the searchnumber---
endDate
Defines the end of the search rangestring---
maxRows
Determines the maximum number of bonus records to be returned in a single responsenumber---

Call example:

getFreeChipBonuses({
  maxRows: 30,
  acceptanceType: '0'
})

Response examples:

{
  code: 0,
  rid: '0',
  data: {
    result: 0,
    result_text: null,
    details: [{
      Id: 1000000000007,
      PartnerBonusId: 630391,
      Source: 2,
      Name: 'Hovotest',
      Description: 'Hovotest',
      StartDate: 1765874700,
      EndDate: 1765961100,
      ClientBonusExpirationDate: 1766150344,
      ExpirationDate: null,
      ExpirationDays: 3,
      IsForVerifiedPlayersOnly: null,
      Amount: 37.5,
      Count: 5,
      AcceptanceType: 0,
      ResultType: 0,
      ExternalId: 316080
    }]
  }
}

Response parameters:

NameDescriptionTypeValues
details
An array of objects, where each object represents an individual free chip bonus available to the playerarray-
└─
object
└─ Id
The unique internal identifier for this specific bonus instancenumber-
└─ PartnerBonusId
The ID of the bonus template as defined by the partner/operatornumber-
└─ Source
Indicates the origin of the bonusnumber-
└─ Name
The display title and marketing text for the bonus, intended for the end-userstring-
└─ Description
The display title and marketing text for the bonus, intended for the end-userstring-
└─ StartDate
The availability start date the bonus can be claimednumber-
└─ EndDate
The availability end date the bonus can be claimednumber-
└─ ClientBonusExpirationDate
The hard deadline by which the client must finish using the bonus after activationnumber-
└─ ExpirationDate
A specific fixed date when the bonus expires, if applicablenumber-
└─ ExpirationDays
The number of days the bonus remains valid once it has been claimed by the playernumber-
└─ IsForVerifiedPlayersOnly
the bonus is restricted to users who have completed the verification processbooleantrue / false
└─ Amount
The monetary value of the free chipnumber-
└─ Count
The number of times this bonus can be used or the number of chips providednumber-
└─ AcceptanceType
The method required to activate the bonusnumber-
└─ ResultType
Defines how the winnings from the bonus are handlednumber-
└─ ExternalId
An identifier for synchronizing with external third-party gaming providers or platforms.number-