Skip to content

Reference / @getenginex/sdk-igaming / BonusPosition

BonusPosition ​

One bonus position of the player (the restricted balance of one grant) with its rollover progress. Amounts in minor units of currency.

Properties ​

campaignId ​

campaignId: string

Campaign id: the name to show comes from the campaign's offer (localizedContent).


converted ​

converted: number

Converted to real balance.


createdAt? ​

optional createdAt?: string

When the position was created, ISO 8601 (UTC).


currency ​

currency: string

Currency code, e.g. BRL.


decimalPlaces ​

decimalPlaces: number

Decimal places of the currency.


expiresAt? ​

optional expiresAt?: string

When the bonus balance expires, ISO 8601 (UTC).


granted ​

granted: number

Amount granted.


positionId ​

positionId: string

Position id.


remaining ​

remaining: number

Still to wager.


required ​

required: number

Amount to wager.


restricted ​

restricted: number

Bonus balance left.


state ​

state: BonusPositionState

open or terminal.


terminalAction? ​

optional terminalAction?: BonusPositionTerminalAction

How it ended (terminal positions only).


wagered ​

wagered: number

Already wagered.