bonus

Playtech.API. bonus

Methods

# (static) getBonusTemplateDetails(options) → {Promise.<{bonusTemplates: Array.<bonusTemplates>}>}

Parameters:
Name Type Description
options Object
Properties
Name Type Description
conversionRate string
minimumConversion string
Returns:
For bonusTemplates see ims docs
Type
Promise.<{bonusTemplates: Array.<bonusTemplates>}>
Example 
Playtech.API.bonus.getBonusTemplateDetails({
 returnGamingContexts: true,
 returnWageringCoefficients: false,
 bonusTemplateCodes:[53759]
}).then(() => {...});

# (static) searchPlayerAvailableBonusTemplates(options) → {Promise.<{nextPageId: string, totalCount: number, pageIds: Array.<string>, matchingBonusTemplates: Array.<matchingBonusTemplates>}>}

Parameters:
Name Type Description
options Object For full acceptable parameters see ims docs
Properties
Name Type Description
templateCode string
templateName string
triggerTypes Array.<string>
playTypes Array.<string>
statuses Array.<string>
schedulingStatuses Array.<string>
eventName string
product Array.<string>
returnTotalCount boolean
pageSize number
pageId string
returnAllPageIds boolean
Returns:
For matchingBonusTemplates see ims docs
Type
Promise.<{nextPageId: string, totalCount: number, pageIds: Array.<string>, matchingBonusTemplates: Array.<matchingBonusTemplates>}>
Example 
Playtech.API.bonus.searchPlayerAvailableBonusTemplates({
  'triggerTypes' : [ 'deposit', 'promotioncode', 'signup' ],
  'promotionCode' : 'TEST',
  'depositMethod' : 'Visa',
  'depositAmount' : '1.1',
  'eturnTotalCount' : true,
  'returnAllPageIds' : true,
  'pageSize' : 50,
  'pageId' : '1',
}).then(() => {...});

# (static) searchPlayerBonuses(options) → {Promise.<{paging: {nextPageId: string, totalCount: number, pageIds: Array.<string>}, bonuses: Array.<bonuses>}>}

Parameters:
Name Type Description
options Object
Properties
Name Type Attributes Description
playerBonusCriteria Object
Properties
Name Type Attributes Description
issuedAfterDate string <optional>
issuedBeforeDate string <optional>
statusFilter string <optional>
 Values: 'current', 'closed', 'redeemed', 'cancelled', 'declined'.
bonusTemplateCriteria string
Properties
Name Type Attributes Description
templateCode string <optional>
templateName string <optional>
triggerTypes Array.<string> <optional>
playTypes Array.<string>
statuses Array.<string> <optional>
schedulingStatuses Array.<string> <optional>
product Array.<string> <optional>
eventName string <optional>
paging Object <optional>
Properties
Name Type Attributes Description
returnTotalCount boolean <optional>
pageSize string
pageId string
returnAllPageIds boolean <optional>
errorLevel number <optional>
Returns:
For bonuses see ims docs
Type
Promise.<{paging: {nextPageId: string, totalCount: number, pageIds: Array.<string>}, bonuses: Array.<bonuses>}>
Example 
Playtech.API.bonus.searchPlayerBonuses().then(() => {...});