Freebet

General information

A freebet is a type of bonus that allows a player to place a one-time bet according to specified parameters (such as a bet on a particular sport).

This type of bet is placed without using the player's personal funds - only the funds from the bonus account are used. The bonus provides players an opportunity to earn winnings from a successful bet.

Freebets are issued by the integrating party, while the calculations (determining whether freebets are successful or not) are performed by the Betting platform.

Calculation Logic

The winnings for a freebet are calculated using the formula:

Winnings = (Stake × Odds) - Freebet Amount

Example

• Bet Stake: 10$
• Freebet amount: 10$
• Odds: 2.0
• Calculation: (10$ × 2.0) - 10$ = 10$

Note: With a regular bet using the player's own funds, the payout would be 20$ (10$ × 2.0) as the stake is returned to the player.

The lifecycle of a freebet

1. The integration client creates a freebet for a specific user through the API.
2. The player sees the available freebet on a website and places a bet with the freebet applied.
   • Integration side will receive the bet_freebet_id field in the /bet/place callback.
   • If bet was accepted: bet_freebet_id will be included in a subsequent /bet/accept callback.
   • If bet was declined or placed with error: the freebet becomes available for use again, and the player's balance remains unchanged.
3. When the bet is settled, a notification is sent to the integration client via /bet/settle:
   • If the bet wins: the player's balance is updated with winnings due to the Freebet Calculation Logic.
   • If the bet loses: the player's balance remains unchanged, and the freebet is considered used and no longer available.
   • If the bet with a freebet is voided (refunded/cancelled): the freebet is considered used and will not be available anymore.

Integration details

The Betting platform provides APIs that allow integrations to create and manage freebets for users. When granted, users can only apply these freebets to wagers that satisfy the conditions specified during creation.

Integrations need to implement their own UI for freebet management (potentially in their back office) and may utilize our Dictionary API to populate some condition values. To define freebet conditions, integrations must send the following parameters in the POST /freebet/create or POST /freebet/create/bulk during creation, and POST /freebet/update methods:

Conditions

Additional Requirements

• Freebets are assigned strictly to a specific player and cannot be transferred or shared
• Freebets are bound to a specific currency and will not be converted if the user has a different currency selected - in such cases, the freebet simply won't be available for use
• At least one condition is required when creating a freebet
• To create a freebet that works with multiple bet types, you need to include separate conditions for each bet type:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

"conditions": [
  {
    "type": "bet_details",
    "data": {
      "bet_details": [
        {"type": "express", "data": {"YOUR_CONDITIONS": null}},
        {"type": "single", "data": {"YOUR_CONDITIONS": null}},
        {"type": "system", "data": {"YOUR_CONDITIONS": null}}
      ]
    }
  }
]

API