Bonus

The bonus event will give you the ability to see actual bonus costs associated to your campaigns. It will also allow you to trigger activities on bonus status changes, e.g. if it's lost too quickly.

REST API

⬆️ POST /v1/integration/bonus

RabbitMQ Connector

RabbitMQ Message Properties

key	value
type	BONUS

The type is expected as a property (but not in the payload) of the RabbitMQ Message. Any header will be ignored.

Kafka Connector

Kafka Message Headers

key	value
type	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,
  "meta":{
		"key1": 10.00,
		"key2": "some string",
		"key3": false
	},
  "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",
  "fasttrack_references":{
		"id": "ABC123-4567-1234-1234-C12345CEBE6",
		"action_id": 2000,
		"action_group_id": 1000,
		"action_communication_profile_id": 1,
		"activity_id": 100,
		"trigger_hash": "9d30070956e392189f3b8daaae9f70b9",
		"player_origin_id": 3
  }
}

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.

When sending 'free spins' bonuses, we expect the first bonus event to be sent once the free spins rounds have been completed and with the correlating "amount" that was won. If you wish to send data when the free spins has been issued, you might send this as a 'Custom Event'.

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
meta	N/A	No	N/A	If meta data is required to be sent
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", "WagerFree", "FreeSpins", "RiskFreeBet", "Undefined"	Bonus type
user_bonus_id	string	Yes	N/A	User bonus id
user_id	string	Yes	N/A	User id
fasttrack_references		No	N/A	Data provided by Fast Track on any bonus crediting requests. Read more about the implementation here.

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.