# Freebets API
**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.
***
## Freebets API Reference
***
### Create a reward
***
## POST /operator/generic/v2/freebet/rewards/create
> The endpoint for creating one reward. You can create rewards of 2 types: \*\*Single-use\*\* and \*\*Campaign-related\*\*.\
> \
> \*\*Creating a Single-use reward\*\*\
> 1\. Get a list of available prepaids via \`/prepaids/list\` endpoint and select a \`prepaid\`.\
> 2\. Add the \`prepaid\_uuid\` to request.\
> 3\. If the \`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\*\*\
> 1\. Create a campaign via \`POST\` \`campaigns/create\`.\
> 2\. Pass the \`campaign\_uuid\`.\
> 3\. \`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.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/rewards/create":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reward"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Rewards.do_create","description":"The endpoint for creating one reward. You can create rewards of 2 types: **Single-use** and **Campaign-related**.\n\n**Creating a Single-use reward**\n1. Get a list of available prepaids via `/prepaids/list` endpoint and select a `prepaid`.\n2. Add the `prepaid_uuid` to request.\n3. If the `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.\n\n**Creating a Campaign-related reward**\n1. Create a campaign via `POST` `campaigns/create`.\n2. Pass the `campaign_uuid`.\n3. `prepaid_uuid`, `bet_value`, `bet_count`, `start_time`, and `end_time` values will be inherited from the campaign.\n\nWe strongly recommend that you set the **start / end dates** for individual rewards and campaigns. Otherwise, the rewards will automatically expire in several weeks.\n","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["user","operator_id"],"properties":{"user":{"description":"","$ref":"#/components/schemas/user"},"sub_partner_id":{"description":"","$ref":"#/components/schemas/sub_partner_id"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"bet_count":{"type":"integer","description":""},"operator_reference":{"type":"string","description":"The unique reference of reward on the Operator's side."}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Reward":{"type":"object","title":"Reward","required":["prepaid_uuid","reward_uuid","game_code","user"],"properties":{"status":{"description":"","$ref":"#/components/schemas/reward_status"},"user":{"description":"","$ref":"#/components/schemas/user"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"bet_count":{"type":"integer","description":"The amount of spins / game rounds to be granted."},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"operator_reference":{"description":"","$ref":"#/components/schemas/operator_reference"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"reward_uuid":{"description":"","$ref":"#/components/schemas/reward_uuid"}},"description":"Hub88 reward item"},"reward_status":{"type":"string","enum":["FRS_NEW: Initial state when rewards are first created","FRS_ACTIVE: reward was created and is available to the player","FRS_CANCELLED: reward was cancelled by the operator","FRS_FAILED: The reward creation failed","FRS_FINISHED: The player already used the reward","FRS_EXPIRED: the expire date was reached"],"description":"The HTTP status code of the response on Provider/Supplier side."},"user":{"type":"string","minLength":3,"description":"The unique user ID in the Operator’s system. In case of DEMO gameplay, this parameter may be omitted."},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"operator_reference":{"type":"string","description":"Unique reference of reward on operator side. Grants idempotency on reward creation."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"reward_uuid":{"type":"string","description":"The unique identifier for an reward on Hub88 side in standard 16-byte UUID format."},"sub_partner_id":{"type":"string","description":"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."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Create multiple rewards in bulk
***
## POST /operator/generic/v2/freebet/rewards/create\_bulk
> 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. You can add max 100 \`user\`s.\
> \
> \`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.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/rewards/create_bulk":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bulk_reward"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Rewards.do_create_bulk","description":"The endpoint for creating **multiple rewards**.\n\nThe 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. You can add max 100 `user`s.\n\n`operator_reference` is a unique identifier of a reward from the Operator's side to ensure accuracy of the rewards.\n\nThe reward properties need to be provided **once per request** and they will be used to create all the rewards in the request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["users","operator_id"],"properties":{"users":{"description":"Maximum 100 users can be added.","$ref":"#/components/schemas/users"},"sub_partner_id":{"description":"","$ref":"#/components/schemas/sub_partner_id"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"bet_count":{"type":"integer","description":""}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Bulk_reward":{"type":"object","title":"Bulk_reward","required":["prepaid_uuid","reward_uuid","game_code","users"],"properties":{"reward":{"description":"","$ref":"#/components/schemas/Bulk_reward_properties"},"success":{"description":"","$ref":"#/components/schemas/Bulk_reward_success"},"failed":{"description":"","$ref":"#/components/schemas/Bulk_reward_failed"},"error":{"type":"boolean","description":"Indicates if there were any errors during reward creation."},"message":{"type":"string","description":""}},"description":"The Hub88 `bulk_reward` item."},"Bulk_reward_properties":{"type":"object","title":"Bulk_reward_properties","required":["prepaid_uuid","game_code"],"properties":{"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"bet_count":{"type":"integer","description":""}},"description":"Properties for a reward on Hub88 side."},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"money_amount":{"type":"integer","description":"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`"},"Bulk_reward_success":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/user"},"reward_uuid":{"$ref":"#/components/schemas/reward_uuid"}}},"description":"Hub88 username and `reward_uuid` for the rewards that were created successfully."},"user":{"type":"string","minLength":3,"description":"The unique user ID in the Operator’s system. In case of DEMO gameplay, this parameter may be omitted."},"reward_uuid":{"type":"string","description":"The unique identifier for an reward on Hub88 side in standard 16-byte UUID format."},"Bulk_reward_failed":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/user"},"reason":{"type":"string","description":"Reason why the creation of a reward failed."}}},"description":"Hub88 user by username, operator refernece, and failure reason for why rewards were not created successfully."},"users":{"type":"array","items":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/user"},"operator_reference":{"type":"string","description":"The unique reference code for a reward on the Operator's side."}}}},"sub_partner_id":{"type":"string","description":"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."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Get a List of Rewards
***
## POST /operator/generic/v2/freebet/rewards/list
> The endpoint for retrieving a list of Rewards. The endpoint allows pagination using cursors, for fetching specific patches of Rewards. See more about \[Pagination here]\().
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/rewards/list":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rewards"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"/operator/generic/v2/freebet/rewards/list","description":"The endpoint for retrieving a list of Rewards. The endpoint allows pagination using cursors, for fetching specific patches of Rewards. See more about [Pagination here](https://docs.hub88.io/developer-docs/hub88-apis/pagination).","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["operator_id"],"properties":{"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"reward_uuid":{"description":"","$ref":"#/components/schemas/reward_uuid"},"user":{"description":"The unique user ID in the Operator’s system.","$ref":"#/components/schemas/user"},"pagination":{"description":"","$ref":"#/components/schemas/pagination"}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Rewards":{"type":"object","title":"Success response","required":["rewards","pagination"],"properties":{"rewards":{"description":"List of Rewards.","type":"array","items":{"type":"object","title":"Reward","required":["prepaid_uuid","reward_uuid","game_code","user"],"properties":{"status":{"description":"","$ref":"#/components/schemas/reward_status"},"user":{"description":"","$ref":"#/components/schemas/user"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"bet_count":{"type":"integer","description":"The amount of spins / game rounds to be granted."},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"operator_reference":{"description":"","$ref":"#/components/schemas/operator_reference"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"reward_uuid":{"description":"","$ref":"#/components/schemas/reward_uuid"}}}},"pagination":{"type":"object","description":"Pagination metadata for navigating paginated results using cursors and limit.","required":["next_cursor","previous_cursor","limit"],"properties":{"next_cursor":{"type":"string","description":"A marker (an opaque string value) representing the first item on the next page."},"previous_cursor":{"type":"string","description":"A marker (an opaque string value) representing the first item on the previous page."},"limit":{"type":"string","description":"Maximum number of items returned per page. Minimum amount 50, maximum 100. Defaults to minimum or maximum limit depending if the value was under or over the established value window."}}}}},"reward_status":{"type":"string","enum":["FRS_NEW: Initial state when rewards are first created","FRS_ACTIVE: reward was created and is available to the player","FRS_CANCELLED: reward was cancelled by the operator","FRS_FAILED: The reward creation failed","FRS_FINISHED: The player already used the reward","FRS_EXPIRED: the expire date was reached"],"description":"The HTTP status code of the response on Provider/Supplier side."},"user":{"type":"string","minLength":3,"description":"The unique user ID in the Operator’s system. In case of DEMO gameplay, this parameter may be omitted."},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"operator_reference":{"type":"string","description":"Unique reference of reward on operator side. Grants idempotency on reward creation."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"reward_uuid":{"type":"string","description":"The unique identifier for an reward on Hub88 side in standard 16-byte UUID format."},"operator_id":{"type":"integer","description":"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."},"pagination":{"type":"object","description":"Pagination metadata for navigating paginated results using cursor and limit. Cursor can be omitted for the first request to this endpoint.","required":["limit"],"properties":{"cursor":{"type":"string","description":"A marker (an opaque string value) representing the first item on the next page."},"limit":{"type":"string","description":"Maximum number of items returned per page. Minimum amount 50, maximum 100. Defaults to minimum or maximum limit depending if the value was under or over the established value window."}}}}}}
```
***
### Cancel a reward
***
## POST /operator/generic/v2/freebet/rewards/cancel
> 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.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/rewards/cancel":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reward"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Rewards.do_cancel","description":"The endpoint for cancelling a granted reward. **Note** that a reward already claimed by a user cannot be canceled.\nEither `reward_uuid` or `operator_reference` must be specified.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["operator_id"],"properties":{"reward_uuid":{"description":"","$ref":"#/components/schemas/reward_uuid"},"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"operator_reference":{"type":"string","description":"The unique reference of reward on the Operator's side."}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Reward":{"type":"object","title":"Reward","required":["prepaid_uuid","reward_uuid","game_code","user"],"properties":{"status":{"description":"","$ref":"#/components/schemas/reward_status"},"user":{"description":"","$ref":"#/components/schemas/user"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"bet_count":{"type":"integer","description":"The amount of spins / game rounds to be granted."},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"operator_reference":{"description":"","$ref":"#/components/schemas/operator_reference"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"reward_uuid":{"description":"","$ref":"#/components/schemas/reward_uuid"}},"description":"Hub88 reward item"},"reward_status":{"type":"string","enum":["FRS_NEW: Initial state when rewards are first created","FRS_ACTIVE: reward was created and is available to the player","FRS_CANCELLED: reward was cancelled by the operator","FRS_FAILED: The reward creation failed","FRS_FINISHED: The player already used the reward","FRS_EXPIRED: the expire date was reached"],"description":"The HTTP status code of the response on Provider/Supplier side."},"user":{"type":"string","minLength":3,"description":"The unique user ID in the Operator’s system. In case of DEMO gameplay, this parameter may be omitted."},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"operator_reference":{"type":"string","description":"Unique reference of reward on operator side. Grants idempotency on reward creation."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"reward_uuid":{"type":"string","description":"The unique identifier for an reward on Hub88 side in standard 16-byte UUID format."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Get a list of available prepaids
***
## POST /operator/generic/v2/freebet/prepaids/list
> 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).
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/prepaids/list":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Prepaids"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Prepaids.do_list","description":"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).","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["operator_id","game_code","currency"],"properties":{"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"currency":{"description":"","$ref":"#/components/schemas/currency"}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Prepaids":{"type":"array","items":{"$ref":"#/components/schemas/Prepaid"}},"Prepaid":{"type":"object","title":"Prepaid","required":["currency","game_code","prepaid_uuid"],"properties":{"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"bet_count":{"type":"integer","description":""},"bonus_buy":{"$ref":"#/components/schemas/bonus_buy"},"meta":{"$ref":"#/components/schemas/prepaids_meta"}},"description":"The prepaid object 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_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"money_amount":{"type":"integer","description":"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`"},"bonus_buy":{"type":"boolean","description":"The prepaids is meant to be used for a free bonus buy. Must not be null."},"prepaids_meta":{"default":{},"type":"object","description":"Legacy support for bonus buy prepaids. Subject to deprecation. Kindly implement `bonus_buy` field only. Must not be null."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Create a campaign
***
## POST /operator/generic/v2/freebet/campaigns/create
> \*\*Creating 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.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/campaigns/create":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Campaigns.do_create","description":"**Creating a campaign:**\n 1. Get a list of available prepaids via `/prepaids/list` and select a prepaid.\n 2. Add the prepaid_uuid to request.\n 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.\n 4. Submit `/campaigns/create` request.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["prepaid_uuid","name","operator_id"],"properties":{"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"name":{"type":"string","description":"The name of the campaign."},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"bet_count":{"type":"integer","description":""},"operator_reference":{"type":"string","description":"The unique reference of a campaign on the Operator's side."}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Campaign":{"type":"object","title":"Campaign","required":["name","prepaid_uuid","campaign_uuid"],"properties":{"name":{"type":"string","description":"The name of the Campaign"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"game_id":{"type":"string","description":"Supplier's internal game ID."},"bet_count":{"type":"integer","description":""},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"operator_reference":{"type":"string","description":"The unique reference of reward on the Operator's side."}},"description":"Hub88 campaign item. Campaign is a form of grouping many rewards by common fields. Example: 'Christmas Campaign'"},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Get a list of campaigns
***
## POST /operator/generic/v2/freebet/campaigns/list
> Provides a list of available campaigns. In some cases, can return a full list of campaigns, including expired campaigns.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/campaigns/list":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaigns"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"Hub88Web.Controllers.Operator.Generic.V2.Freebet.Campaigns.do_list","description":"Provides a list of available campaigns. In some cases, can return a full list of campaigns, including expired campaigns. ","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["operator_id"],"properties":{"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"name":{"type":"string","description":"The name of the campaign."},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"operator_reference":{"type":"string","description":"The unique reference of a campaign on the Operator's side."}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}},"Campaign":{"type":"object","title":"Campaign","required":["name","prepaid_uuid","campaign_uuid"],"properties":{"name":{"type":"string","description":"The name of the Campaign"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"game_id":{"type":"string","description":"Supplier's internal game ID."},"bet_count":{"type":"integer","description":""},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"operator_reference":{"type":"string","description":"The unique reference of reward on the Operator's side."}},"description":"Hub88 campaign item. Campaign is a form of grouping many rewards by common fields. Example: 'Christmas Campaign'"},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"operator_id":{"type":"integer","description":"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."}}}}
```
***
### Get a Campaign by UUID
## POST /operator/generic/v2/freebet/campaigns/info
> Provides details of a specified Campaign.
```json
{"openapi":"3.1.1","info":{"title":"Hub88","version":"2.0"},"tags":[{"name":"Freebets API","description":"Freebets API lets you grant rewards (freespins, freebets, prizes) to a single user or several users.\n First-time-user bonuses are supported by most providers. In some cases, before granting a free bet a player must interact with the game to properly use it."}],"paths":{"/operator/generic/v2/freebet/campaigns/info":{"post":{"tags":["Freebets API"],"summary":"","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"parameters":[{"schema":{"type":"string"},"required":true,"name":"X-Hub88-Signature","in":"header","description":"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`."}],"operationId":"/operator/generic/v2/freebet/campaigns/info","description":"Provides details of a specified Campaign.","requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["campaign_uuid","operator_id"],"properties":{"operator_id":{"description":"","$ref":"#/components/schemas/operator_id"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"}}}}},"required":true,"description":""}}}},"components":{"schemas":{"Campaign":{"type":"object","title":"Campaign","required":["name","prepaid_uuid","campaign_uuid"],"properties":{"name":{"type":"string","description":"The name of the Campaign"},"start_time":{"description":"","$ref":"#/components/schemas/datetime"},"currency":{"description":"","$ref":"#/components/schemas/currency"},"end_time":{"description":"","$ref":"#/components/schemas/datetime"},"game_code":{"description":"","$ref":"#/components/schemas/game_code"},"game_id":{"type":"string","description":"Supplier's internal game ID."},"bet_count":{"type":"integer","description":""},"bet_value":{"description":"","$ref":"#/components/schemas/money_amount"},"prepaid_uuid":{"description":"","$ref":"#/components/schemas/prepaid_uuid"},"campaign_uuid":{"description":"","$ref":"#/components/schemas/campaign_uuid"},"operator_reference":{"type":"string","description":"The unique reference of reward on the Operator's side."}},"description":"Hub88 campaign item. Campaign is a form of grouping many rewards by common fields. Example: 'Christmas Campaign'"},"datetime":{"type":"string","format":"ISO-8601","description":"The date and time combination in [ISO 8601 Extended format](https://www.iso.org/iso-8601-date-and-time-format.html) (YYYY-MM-DDThh:mm:ss)."},"currency":{"type":"string","enum":["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","mBTC"],"description":"The [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) 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."},"game_code":{"type":"string","description":"The unique game identifier in Hub88 system in the form of a string. `game_code` can be obtained from the `/game/list` endpoint."},"money_amount":{"type":"integer","description":"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`"},"prepaid_uuid":{"type":"string","description":"Standard 16-byte prepaid's unique ID (UUID) on Hub88 side referencing a prepaid reward."},"campaign_uuid":{"type":"string","description":"The unique campaign ID in Hub88 side, displayed in standard 16-byte UUID format."},"operator_id":{"type":"integer","description":"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."}}}}
```