Freebets API

---

Freebets API Reference: Supplier API

---

Get a list of prepaids

---

post

Returns the list of available prepaids. A prepaid is a reward template which specifies obtainable rounds or spins (bet_count), value of each round or spin (bet_value), and the currency of the reward per game. For bonus_buy prepaids, the bet_count does not matter. bet_value specifies the worth of the bonus.

Header parameters

X-Hub88-SignaturestringRequired

RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

application/json

operator_idintegerRequired

The unique identifier of Hub88 configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

Example: 1

game_codestringOptional

The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

Example: clt_dragonrising

Responses

200

OK

application/json

Prepaid defines the format and size of the rewards set by the game Supplier. If bet_count is set as null, there are no constraints applied to it. Bet size (bet_value) is defined by the number of lines, minimum and maximum bet limits and other in-game math.

prepaid_uuidstringRequired

Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward.

Example: 0e6bde62-4713-4b85-b510-59f0d729d8f7

game_codestringRequired

The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

Example: clt_dragonrising

currencystring · enumRequired

The ISO 4217 currency code. The following list contains all currencies supported by the Hub88 system. Note that native game play support with these currencies may vary per Provider.

Example: EURPossible values:

bet_valueintegerOptional

The amount of money is displayed in integers (Int64). To convert real float value to integer Hub88 multiplys it by 100000. Example: $3.56 must be represented as 356000

bet_countintegerOptional

The amount of spins / game rounds to be granted.

Example: 5

bonus_buybooleanOptional

The prepaids is meant to used for free bonus buy.

Example: true

metaobjectOptional

Legacy support for bonus buy prepaids. Subject to deprecation. Kindly implement bonus_buy field only

Default: {}

post

/freebet/prepaids/list

HTTPcURLJavaScriptPython

POST /freebet/prepaids/list HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "operator_id": 1,
  "game_code": "clt_dragonrising"
}

200

OK

[
  {
    "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
    "game_code": "clt_dragonrising",
    "currency": "EUR",
    "bet_value": 0,
    "bet_count": 5,
    "bonus_buy": true,
    "meta": {}
  }
]

---

Create a reward

---

post

Endpoint for creating rewards. Should support creating rewards/bonuses.

Creating a single-use reward:

1. The prepaid_uuid is specified in the request.

2. If bet_value and/or bet_count in the prepaid is NULL, any values can be shared. Otherwise, the values from the prepaid will be used to create the reward.

Header parameters

X-Hub88-SignaturestringRequired

RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

application/json

reward_uuidstringOptional

The unique identifier for an reward on Hub88 side in standard 16-byte UUID format.

Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by the Hub88 system. Note that native game play support with these currencies may vary per Provider.

Example: EURPossible values:

userstringRequired

The unique user ID in the Hub88's system. In case of DEMO gameplay, this parameter may be omitted.

Example: john12345

sub_partner_idstringOptional

ID of an Hub88's sub-partner (brand, whitelabel, site, etc.) which uses the same integration and credentials as the Hub88. Used for detailed reporting and integration type switching.

Example: my-casino-id

start_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

prepaid_uuidstringOptional

Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward.

Example: 0e6bde62-4713-4b85-b510-59f0d729d8f7

operator_idintegerRequired

The unique identifier of Hub88 configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

Example: 1

game_codestringOptional

The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

Example: clt_dragonrising

end_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

bet_valueintegerOptional

The amount of money is displayed in integers (Int64). To convert real float value to integer Hub88 multiplys it by 100000. Example: $3.56 must be represented as 356000

bet_countintegerOptional

The amount of spins / game rounds to be granted.

Example: 5

Responses

200

OK

application/json

The Hub88 reward item

userstringRequired

The unique user ID in the Hub88's system. In case of DEMO gameplay, this parameter may be omitted.

Example: john12345

start_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

reward_uuidstringRequired

The unique identifier for an reward on Hub88 side in standard 16-byte UUID format.

Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

prepaid_uuidstringRequired

Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward.

Example: 0e6bde62-4713-4b85-b510-59f0d729d8f7

game_codestringOptional

The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

Example: clt_dragonrising

end_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by the Hub88 system. Note that native game play support with these currencies may vary per Provider.

Example: EURPossible values:

bet_valueintegerOptional

The amount of money is displayed in integers (Int64). To convert real float value to integer Hub88 multiplys it by 100000. Example: $3.56 must be represented as 356000

bet_countintegerOptional

The amount of spins / game rounds to be granted.

Example: 5

post

/freebet/rewards/create

HTTPcURLJavaScriptPython

POST /freebet/rewards/create HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 319

{
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "currency": "EUR",
  "user": "john12345",
  "sub_partner_id": "my-casino-id",
  "start_time": "2017-11-05T13:15:30",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "operator_id": 1,
  "game_code": "clt_dragonrising",
  "end_time": "2017-11-05T13:15:30",
  "bet_value": 0,
  "bet_count": 5
}

200

OK

{
  "user": "john12345",
  "start_time": "2017-11-05T13:15:30",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "game_code": "clt_dragonrising",
  "end_time": "2017-11-05T13:15:30",
  "currency": "EUR",
  "bet_value": 0,
  "bet_count": 5
}

---

Cancel a reward

---

post

Endpoint for canceling an reward. Please note that reward already claimed by user cannot be canceled.

Header parameters

X-Hub88-SignaturestringRequired

RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.

Body

application/json

reward_uuidstringRequired

The unique identifier for an reward on Hub88 side in standard 16-byte UUID format.

Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

operator_idintegerRequired

The unique identifier of Hub88 configuration in the Supplier's system used to authorize incoming requests. Could be either interger or a string.

Example: 1

Responses

200

OK

application/json

The Hub88 reward item

userstringRequired

The unique user ID in the Hub88's system. In case of DEMO gameplay, this parameter may be omitted.

Example: john12345

start_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

reward_uuidstringRequired

The unique identifier for an reward on Hub88 side in standard 16-byte UUID format.

Example: a28f93f2-98c5-41f7-8fbb-967985acf8fe

prepaid_uuidstringRequired

Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward.

Example: 0e6bde62-4713-4b85-b510-59f0d729d8f7

game_codestringOptional

The unique game identifier in Provider's system in the form of a string. game_code can be obtained from the /game/list endpoint and is a required parameter.

Example: clt_dragonrising

end_timestring · ISO-8601Optional

The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).

Example: 2017-11-05T13:15:30

currencystring · enumOptional

The ISO 4217 currency code. The following list contains all currencies supported by the Hub88 system. Note that native game play support with these currencies may vary per Provider.

Example: EURPossible values:

bet_valueintegerOptional

The amount of money is displayed in integers (Int64). To convert real float value to integer Hub88 multiplys it by 100000. Example: $3.56 must be represented as 356000

bet_countintegerOptional

The amount of spins / game rounds to be granted.

Example: 5

post

/freebet/rewards/cancel

HTTPcURLJavaScriptPython

POST /freebet/rewards/cancel HTTP/1.1
X-Hub88-Signature: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "operator_id": 1
}

200

OK

{
  "user": "john12345",
  "start_time": "2017-11-05T13:15:30",
  "reward_uuid": "a28f93f2-98c5-41f7-8fbb-967985acf8fe",
  "prepaid_uuid": "0e6bde62-4713-4b85-b510-59f0d729d8f7",
  "game_code": "clt_dragonrising",
  "end_time": "2017-11-05T13:15:30",
  "currency": "EUR",
  "bet_value": 0,
  "bet_count": 5
}

---