Freebets API
Last updated
Was this helpful?
Last updated
Was this helpful?
Freebets API is used for granting rewards, and reward campaigns to one or multiple users. First-time user's bonuses are supported by most suppliers, however, in some cases a player must interact with the game before a free bet can be granted.
The endpoint for creating one reward. You can create rewards of 2 types: Single-use and Campaign-related.
Creating a Single-use reward
/prepaids/list endpoint and select a prepaid.prepaid_uuid to request.bet_value and/or the bet_count in the prepaid's value is set to NULL, you can enter any values. Otherwise, the values from the prepaid will be used to create the reward.Creating a Campaign-related reward
POST campaigns/create.campaign_uuid.prepaid_uuid, bet_value, bet_count, start_time, and end_time values will be inherited from the campaign.We strongly recommend that you set the start / end dates for individual rewards and campaigns. Otherwise, the rewards will automatically expire in several weeks.
/operator/generic/v2/freebet/rewards/create
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.
The unique user ID in the Operator’s system. In case of DEMO gameplay, this parameter may be omitted.
ID of Operator's sub-partner (brand, whitelabel, site, etc.) which uses same integration and credentials as an Operator. Used for detailed reporting and integration type switching. Sites under the same Operator can use different integration types: TransferWallet or SeamlessWallet. A single site (sub_partner_id) can NOT have both kinds of integration at the same time.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
Standard 16-byte unique user ID (UUID) on Hub88 side referencing a prepaid reward.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.
The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format.
The amount of money displayed in integer**(Int64)** format. To convert real float value to integer, it is multiplied by 100000. Example: $3.56 is represented as 356000
The unique reference of reward on the Operator's side.
The endpoint for creating multiple rewards.
The process is similar to creating one reward (see POST /operator/generic/v2/freebet/rewards/create), but instead of one user you need to provide a list of users. All user's items need to include user and a unique operator_reference per user.
operator_reference is a unique identifier of a reward from the Operator's side to ensure accuracy of the rewards.
The reward properties need to be provided once per request and they will be used to create all the rewards in the request.
/operator/generic/v2/freebet/rewards/create_bulk
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.
ID of Operator's sub-partner (brand, whitelabel, site, etc.) which uses same integration and credentials as an Operator. Used for detailed reporting and integration type switching. Sites under the same Operator can use different integration types: TransferWallet or SeamlessWallet. A single site (sub_partner_id) can NOT have both kinds of integration at the same time.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
Standard 16-byte unique user ID (UUID) on Hub88 side referencing a prepaid reward.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.
The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format.
The amount of money displayed in integer**(Int64)** format. To convert real float value to integer, it is multiplied by 100000. Example: $3.56 is represented as 356000
The endpoint for cancelling a granted reward. Note that a reward already claimed by a user cannot be canceled.
Either reward_uuid or operator_reference must be specified.
/operator/generic/v2/freebet/rewards/cancel
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.
The unique identifier for an reward on Hub88 side in standard 16-byte UUID format.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.
The unique reference of reward on the Operator's side.
Provides a list of all available prepaids. Prepaids with field bonus_buy set to true are meant to give a free bonus buy and are not suitable to be used for multiple (bet_count).
/operator/generic/v2/freebet/prepaids/list
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.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.
The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.
The ISO 4217 currency code. The following list contains all currencies supported by our system. Note that native gameplay support for these currencies may vary per Provider. Please contact us to know which Provider supports which currencies.
BSD, TTD, ZMW, BMD, USD, BYR, UGX, HKD, MGA, GIP, UZS, MKD, PTS, mLTC, EGP, AWG, CZK, ILS, MZN, TND, XPF, SOS, DOP, RUB, KRW, BTN, KGS, BAM, AOA, SOC, AMS, BND, RSD, FKP, PEN, EOS, GHS, JPY, TRY, SBD, UAH, LTL, FJD, GNF, MDL, AFN, ZAR, MOP, TJS, BOB, JMD, QAR, IRR, SYP, XXX, NAD, MYR, CUP, NOK, BGN, KPW, MNT, NZD, uETH, SGD, PYG, OMR, DZD, EUR, TMT, MMK, PTQ, ANG, TZS, CRC, VES, ETB, THB, ZWD, LYD, CHF, MVR, KES, CVE, LSL, KMF, SZL, KYD, BRL, AED, WST, YER, ALL, TRX, HUF, GTQ, uBTC, IDR, MWK, CUC, DKK, TWD, XCD, BBD, LRD, KZT, JOD, BYN, BIF, PLN, SDG, VUV, SEK, BDT, HNL, BWP, VND, ISK, SLL, BHD, HTG, USDT, ADA, MUR, ERN, uLTC, LKR, COP, GEL, AUD, GBP, CAD, PHP, PAB, DJF, GMD, PKR, NIO, AMD, RWF, RON, NGN, TOP, UYU, AZN, SRD, KWD, PGK, CDF, SAR, IQD, XRP, SCR, mETH, MAD, GYD, INR, LBP, ARS, MXN, CLP, BNB, CNY, KHR, LAK, HRK, BZD, SSP, XOF, X5T, MRO, NPR, mBTCCreating a campaign:
1. Get a list of available prepaids via /prepaids/list and select a prepaid.
2. Add the prepaid_uuid to request.
3. If bet_value and/or bet_count in the prepaid is NULL, you can enter any values. Otherwise, the values from the prepaid will be used to create the reward.
4. Submit /campaigns/create request.
/operator/generic/v2/freebet/campaigns/create
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.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
Standard 16-byte unique user ID (UUID) on Hub88 side referencing a prepaid reward.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.
The unique game identifier in Hub88 system in the form of a string. game_code can be obtained from the /game/list endpoint.
The date and time combination in ISO 8601 Extended format (YYYY-MM-DDThh:mm:ss).
The amount of money displayed in integer**(Int64)** format. To convert real float value to integer, it is multiplied by 100000. Example: $3.56 is represented as 356000
The name of the campaign.
The unique reference of a campaign on the Operator's side.
Provides a list of available campaigns.
/operator/generic/v2/freebet/campaigns/list
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.
Unique identifier for the Operator in Hub88 system. Used to authorize incoming requests. You can obtain your operator_id from the Hub88 BackOffice after your Operator entity is registered and set up in the Hub88 system by the internal teams.