⬆️ POST /v1/integration/bonus

Request

    
{
"amount": 10.3,
"bonus_code": "WELCOME100",
"bonus_id": "9821",
"bonus_turned_real": 0,
"currency": "EUR",
"exchange_rate": 0.1,
"locked_amount": 2.3,
"origin": "sub.example.com",
"product": "Casino",
"required_wagering_amount": 412.3,
"status": "Created",
"timestamp": "2015-03-02T8:27:58.721607+06:00",
"type": "WelcomeBonus",
"user_bonus_id": "863512",
"user_id": "7865312321"
}

It's important that only one event is sent when the status of the bonus is changed. Multiple events of the same status will result in the segmentation data being incorrect.

Key

Type

Required?

Accepted Values

Description

amount

float

Yes

N/A

Bonus amount

bonus_code

string

No

N/A

Bonus code

bonus_id

string

Yes

N/A

Bonus id

bonus_turned_real

float

No

N/A

Bonus amount turned to real money: If wagering is finished.

currency

string

Yes

Format: ISO 4217

e.g. "EUR"

Currency

exchange_rate

float

Yes

e.g. 0.1

The exchange rate at the timestamp

locked_amount

float

No

N/A

Bonus amount locked to wagering

origin

string

Yes

e.g. www.brand.com

N/A

product

string

Yes

"Casino", "Sportsbook", "Lotto", "Poker"

Product type

required_wagering_amount

float

No

N/A

Required wagering amount of bonus

status

string

Yes

"Pending", "Created", "Ongoing", "Completed", "Autocompleted", "Forfeited", "Expired", "Lost", "Reversed"

Bonus status

timestamp

string

Yes

Format: RFC3339 2015-03-02T8:27:58.10Z

Timestamp

type

string

Yes

"NoDeposit", "WelcomeBonus", "CashbackBonus", "ReloadBonus", "FreeSpins", "WelcomeFreeSpins", "SportsWelcomeBonus", "RiskFreeBet", "SportsReloadBonus", "PersonalizedRiskFreeBet", "SportsNoDeposit", "SportsManualCashback"

Bonus type

user_bonus_id

string

Yes

N/A

User bonus id

user_id

string

Yes

N/A

User id

Status descriptions

Status

Description

Pending

When a bonus has been given to the player but not yet been claimed.

Created

When the bonus has been claimed and the funds are added to the player’s account.

Ongoing

When wagering has started by the user. e.g. player places the first bet with the bonus funds. *This event can be sent multiple times to track how the player progresses with the wagering requirement.

Completed

If the wagering requirement is fulfilled and the bonus funds are turned into real funds.

Autocompleted

If your system automatically removes the bonus with a general setting. e.g. Bonuses are autocompleted if the balance reaches under €0.10

Forfeited

If the bonus has been forfeited.

Expired

If the validity period of the bonus has expired.

Lost

If the player has run out of bonus balance.

Reversed

When a previously active bonus has been credited back to the player’s account, usually when there’s a canceled withdrawal.