Nolimit City

https://docs.nolimitcity.com/
Admin
Nolimit City provides a system for game loading, wallet integration (including Wallet API, Free Bets...
Tokens:22,658
Snippets:106
Trust Score:7.5
Update:8 months ago
Show doc for...
Tokens:
Raw
### Feature Bet Get Request and Response Example

Source: https://docs.nolimitcity.com/docs/featurebets-api/featurebets-get

This snippet demonstrates the JSON structure for both the request to the featurebet.get endpoint and its corresponding response. The request includes identification and userId, while the response details active and in-progress feature bet promotions.

```json
{
  "jsonrpc": "2.0",
  "method": "featurebet.get",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_API_KEY"
    },
    "userId":"user_4b5727162"
  },
  "id": "<insert unique UUID here>"
}

```

```json
{
  "jsonrpc": "2.0",
  "result": {
    "featureBets": [
      {
        "operator": "FAKE1",
        "promoName": "11001",
        "startTime": "2022-08-24T10:21:23",
        "created": "2022-08-24T10:21:23"
        "expires": "2022-12-01T00:00:00",
        "evictTime": "2022-12-31T23:59:59",
        "gameName": "BookOfShadows",
        "featureName": "FREESPIN_3_ROWS",
        "userId": "user_4b5727162",
        "betLevel": {
          "amount": 1.0000000000000000,
          "currency": "EUR"
        },
        "cost": {
          "amount": 60.0000000000000000,
          "currency": "EUR"
        }
      },
    ]
  },
  "id": "<will match unique UUID from above>"
}

```

--------------------------------

### Wallet Withdraw Error Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/withdraw

This JSON object shows an example of an error response from the wallet.withdraw method. It includes an error code and a message indicating the reason for failure, such as 'Insufficient funds'.

```json
{
  "jsonrpc": "2.0",
  "error": {
    "code": -32000,
    "message": "Server error",
    "data": {
      "code": 14001,
      "message": "Insufficient funds"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Balance Response (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/balance

Example response structure for a single user balance request. Includes the balance amount and currency.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "balance": {
      "amount": 110.00,
      "currency": "EUR"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Deposit API Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/deposit

This JSON object represents a sample request to the wallet.deposit API. It includes essential parameters such as operator identification, user ID, deposit amount and currency, and detailed information for tracking the transaction.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.deposit",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userId": "xyz_123",
    "deposit": {
      "amount": 10.00,
      "currency": "EUR"
    },
    "information": {
      "uniqueReference": "...",
      "gameRoundId": "...",
      "game": "...",
      "time": "2016-01-02T12:34:56.789Z"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Withdraw Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/withdraw

This JSON object demonstrates a typical request payload for the wallet.withdraw method. It includes essential parameters like identification, userId, and the withdraw amount and currency. The 'information' object provides context for the transaction.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.withdraw",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userId": "xyz_123",
    "withdraw": {
      "amount": 10.00,
      "currency": "EUR"
    },
    "information": {
      "uniqueReference": "...",
      "gameRoundId": "...",
      "game": "...",
      "time": "2016-01-02T12:34:56.789Z"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Rollback Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/rollback

This JSON object demonstrates the structure of a request to the wallet.rollback method. It includes essential parameters like identification, userId, and detailed information about the transaction context.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.rollback",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userId": "xyz_123",
    "information": {
      "uniqueReference": "...",
      "gameRoundId": "...",
      "game": "...",
      "time": "2016-01-02T12:34:56.789Z"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Rollback Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/rollback

This JSON object illustrates a successful response from the wallet.rollback method. It typically contains the updated user balance and an optional transaction ID for reference.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "balance": {
      "amount": 110.00,
      "currency": "EUR"
    },
    "transactionId": "xyz123456"
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### games.list API Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/freebets-api/games-list

This JSON object demonstrates the structure of a request to the games.list API endpoint. It includes the necessary identification parameters and an optional currency for filtering game data.

```json
{
  "jsonrpc": "2.0",
  "method": "games.list",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "currency": "EUR"
  },
  "id": "<insert unique UUID here>"
}
```

--------------------------------

### Free Bets Get

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-get

Retrieves information about active and in-progress free bet promotions for a specified user.

```APIDOC
## POST /freebets.get

### Description
Used to get information about active and in progress free bet promotions.

### Method
POST

### Endpoint
/freebets.get

### Parameters
#### Request Body
- **identification** (IDENTIFICATION) - Required - See common objects above.
- **userId** (STRING) - Required - The user id to fetch free bets information for.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "freebets.get",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "userId":"user_4b5727162"
  },
  "id": "<insert unique UUID here>"
}
```

### Response
#### Success Response (200)
- **freeBets** (Array) - List of active and in progress free bet promotions.
  - **userId** (STRING) - The user id to fetch free bets information for.
  - **operator** (STRING) - The operator the promotion belongs to.
  - **promoName** (STRING) - The name of the promotion.
  - **gameName** (STRING) - The game the promotion is valid for.
  - **amount** (MONEY) - Bet amount per round.
  - **rounds** (NUMBER) - Awarded number of rounds.
  - **roundsUsed** (NUMBER) - Rounds played.
  - **created** (STRING) - Promotion create date.
  - **startTime** (STRING) - First time when the promotion can be taken by the player.
  - **expires** (STRING) - Date and time up until when the promotion can be accepted/activated by the player. If the promotion has been accepted/activated by the player before this specified date and time, the player can play the offer till the `eviction` date and time.
  - **evictTime** (STRING) - Date and time up until when the promotion is to be completely voided. This only occurs in the event that the player has activated the promo within the time/date set in `expires` field. Please note that if the `eviction` parameter is not filled in, then the player can keep playing this offer without a date and time limit and the promotion is only closed after all rounds have been played.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "result": {
    "freeBets": [
      {
        "userId": "user_4b5727162",
        "operator": "OPERATOR",
        "promoName": "user_4b5727162_promo1",
        "gameName": "Karen",
        "amount": {
          "amount": 10.00,
          "currency": "SEK"
        },
        "rounds": 5,
        "roundsUsed": 1,
        "created": "2023-05-21T08:53:32",
        "startTime": "2023-05-21T08:53:32",
        "expires": "2023-05-21T14:09:00",
        "evictTime": "2023-05-31T14:09:00"
      }
    ]
  },
  "id": "<will match unique UUID from above>"
}
```
```

--------------------------------

### Wallet Withdraw Success Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/withdraw

This JSON object illustrates a successful response from the wallet.withdraw method. It confirms the transaction with a unique transactionId and provides the updated balance after the withdrawal.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "balance": {
      "amount": 100.00,
      "currency": "EUR"
    },
    "transactionId": "xyz123456"
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Validate Token Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/validate-token

Example JSON payload for the wallet.validate-token API request. It includes identification, token, and game parameters required to validate a user's session.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.validate-token",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "token": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "game": "CreepyCarnival"
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Wallet Balances Response (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/balance

Example response structure for a multiple user balance request. Returns an object mapping user IDs to their respective balances.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "balances": {
      "xyz_123": {
        "amount": 110.00,
        "currency": "EUR"
      },
      "xyz_456": {
        "amount": 25.25,
        "currency": "SEK"
      }
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Free Bets Cancel Request Example (JSON)

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-cancel

This JSON object demonstrates the structure of a request to the freebets.cancel API. It includes identification details and the promotion name to be canceled. The 'evict' parameter is also shown, though its specific function is not detailed here.

```json
{
  "jsonrpc": "2.0",
  "method": "freebets.cancel",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "promoName":"user_4b5727162-promo",
    "evict":true
  },
  "id": "<insert unique UUID here>"
}
```

--------------------------------

### Request Example for games.feature-list API

Source: https://docs.nolimitcity.com/docs/featurebets-api/game-feature-list

This JSON object demonstrates the structure of a request to the 'games.feature-list' API endpoint. It includes the method, parameters for identification (operator name and key), and a unique ID for tracking the request.

```json
{
  "jsonrpc": "2.0",
  "method": "games.feature-list",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_API_KEY"
    }
  },
  "id": "<insert unique UUID here>"
}
```

--------------------------------

### Validate Token Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/validate-token

Example JSON payload for the wallet.validate-token API response. It returns user details such as userId, username, balance, and custom bet limits upon successful token validation.

```json
{
  "jsonrpc": "2.0",
  "result": {
    "userId": "xyz_123",
    "username": "That Guy",
    "balance": {
      "amount": 100.00,
      "currency": "EUR"
    },
    "customBetLimits": {
      "defaultBet": 0.2,
      "maxBet": 5.00
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Feature Bet Get API

Source: https://docs.nolimitcity.com/docs/featurebets-api/featurebets-get

Retrieves information about active and in-progress feature bet promotions for a specific user.

```APIDOC
## POST /featurebet.get

### Description
Used to get information about active and in progress feature bet promotions.

### Method
POST

### Endpoint
/featurebet.get

### Parameters
#### Request Body
- **identification** (OBJECT) - Required - See common objects above.
  - **name** (STRING) - Required - The name of the identification.
  - **key** (STRING) - Required - The key for the identification.
- **userId** (STRING) - Required - The user id to fetch feature bet information for.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "featurebet.get",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_API_KEY"
    },
    "userId": "user_4b5727162"
  },
  "id": "<insert unique UUID here>"
}
```

### Response
#### Success Response (200)
- **featureBets** (Array) - List of active and in progress feature bet promotions
  - **featureBets.operator** (STRING) - The operator the promotion belongs to.
  - **featureBets.promoName** (STRING) - The name of the promotion.
  - **featureBets.startTime** (STRING) - First time when the promotion can be taken by the player.
  - **featureBets.created** (STRING) - Promotion create date.
  - **featureBets.expires** (STRING) - Date and time up until when the promotion can be accepted/activated by the player. If the promotion has been accepted/activated by the player before this specified date and time, the player can play the offer till the `eviction` date and time.
  - **featureBets.evictTime** (STRING) - Date and time up until when the promotion is to be completely voided. This only occurs in the event that the player has activated the promo within the time/date set in `expires` field. Please note that if the `eviction` parameter is not filled in, then the player can keep playing this offer without a date and time limit and the promotion is only closed after all rounds have been played.
  - **featureBets.gameName** (STRING) - The game the promotion is valid for.
  - **featureBets.featureName** (STRING) - The name of the feature. Eg. “FREESPIN_SUPER”.
  - **featureBets.userId** (STRING) - The user id to fetch feature bets information for.
  - **featureBets.betLevel** (OBJECT) - The information of the betlevel
    - **featureBets.betLevel.amount** (NUMBER) - The value of the betlevel
    - **featureBets.betLevel.currency** (STRING) - The corresponding currency of the betlevel
  - **featureBets.cost** (MONEY) - Bet level multiplied by the cost of the particular feature. See games.feature-list for values.
    - **featureBets.cost.amount** (NUMBER) - The amount of the cost.
    - **featureBets.cost.currency** (STRING) - The currency of the cost.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "result": {
    "featureBets": [
      {
        "operator": "FAKE1",
        "promoName": "11001",
        "startTime": "2022-08-24T10:21:23",
        "created": "2022-08-24T10:21:23",
        "expires": "2022-12-01T00:00:00",
        "evictTime": "2022-12-31T23:59:59",
        "gameName": "BookOfShadows",
        "featureName": "FREESPIN_3_ROWS",
        "userId": "user_4b5727162",
        "betLevel": {
          "amount": 1.0000000000000000,
          "currency": "EUR"
        },
        "cost": {
          "amount": 60.0000000000000000,
          "currency": "EUR"
        }
      }
    ]
  },
  "id": "<will match unique UUID from above>"
}
```
```

--------------------------------

### Get Free Bets Information (JSON-RPC)

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-get

This snippet demonstrates how to make a JSON-RPC request to the freebets.get endpoint to retrieve active and in-progress free bet promotions for a given user. It includes the necessary identification parameters and the user ID. The response structure is also shown, detailing the properties of each free bet object.

```JSON
{
  "jsonrpc": "2.0",
  "method": "freebets.get",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "userId":"user_4b5727162"
  },
  "id": "<insert unique UUID here>"
}
```

```JSON
{
  "jsonrpc": "2.0",
  "result": {
    "freeBets": [
      {
        "userId": "user_4b5727162",
        "operator": "OPERATOR",
        "promoName": "user_4b5727162_promo1",
        "gameName": "Karen",
        "amount": {
          "amount": 10.00,
          "currency": "SEK"
        },
        "rounds": 5,
        "roundsUsed": 1,
        "created": "2023-05-21T08:53:32",
        "startTime": "2023-05-21T08:53:32",
        "expires": "2023-05-21T14:09:00",
        "evictTime": "2023-05-31T14:09:00"
      }
    ]
  },
  "id": "<will match unique UUID from above>"
}
```

--------------------------------

### Free Bets API - Free Bets Get

Source: https://docs.nolimitcity.com/docs/freebets-api

Endpoint for retrieving information about free bets.

```APIDOC
## POST /freebets/get

### Description
Retrieves information about existing free bets for a player or a specific free bet.

### Method
POST

### Endpoint
`/freebets/get`

### Parameters
#### Query Parameters
None

#### Request Body
```json
{
  "jsonrpc": "2.0",
  "method": "freebets.get",
  "params": {
    "identification": {
      "name": "OperatorName",
      "key": "OperatorKey"
    },
    "playerId": "<string>",
    "freeBetId": "<string>" (Optional)
  },
  "id": "<uuid>"
}
```
- **identification** (object) - Required - Operator identification details.
  - **name** (string) - Required - Operator name.
  - **key** (string) - Required - Operator key.
- **playerId** (string) - Required - The unique identifier for the player.
- **freeBetId** (string) - Optional - The unique identifier for a specific free bet. If omitted, all active free bets for the player are returned.

### Request Example (Get all for player)
```json
{
  "jsonrpc": "2.0",
  "method": "freebets.get",
  "params": {
    "identification": {
      "name": "MyCasino",
      "key": "secretkey123"
    },
    "playerId": "player789"
  },
  "id": "a1a1a1a1-b2b2-c3c3-d4d4-e5e5e5e5e5e5"
}
```

### Request Example (Get specific free bet)
```json
{
  "jsonrpc": "2.0",
  "method": "freebets.get",
  "params": {
    "identification": {
      "name": "MyCasino",
      "key": "secretkey123"
    },
    "playerId": "player789",
    "freeBetId": "fb_abc123xyz"
  },
  "id": "b2b2b2b2-c3c3-d4d4-e5e5-f6f6f6f6f6f6"
}
```

### Response
#### Success Response (200)
- **result** (object) - Contains the details of the free bet(s).
  - **freeBets** (array) - An array of free bet objects. If `freeBetId` was provided and found, this array will contain a single object.
    - **freeBetId** (string) - The unique identifier for the free bet.
    - **playerId** (string) - The player's unique identifier.
    - **gameId** (string) - The game's unique identifier.
    - **roundsRemaining** (integer) - The number of free rounds remaining.
    - **valuePerRound** (object) - The value of each free round.
      - **amount** (string) - The amount for each round.
      - **currency** (string) - The ISO 4217 currency code.
    - **status** (string) - The current status of the free bet (e.g., 'active', 'used', 'expired').
    - **createdAt** (string) - Timestamp when the free bet was created.
    - **expiresAt** (string) - Timestamp when the free bet expires.
- **id** (string) - The request ID.

#### Response Example (Multiple free bets)
```json
{
  "jsonrpc": "2.0",
  "result": {
    "freeBets": [
      {
        "freeBetId": "fb_abc123xyz",
        "playerId": "player789",
        "gameId": "game123",
        "roundsRemaining": 8,
        "valuePerRound": {
          "amount": "1.50",
          "currency": "EUR"
        },
        "status": "active",
        "createdAt": "2023-10-27T10:00:00Z",
        "expiresAt": "2023-11-27T10:00:00Z"
      },
      {
        "freeBetId": "fb_def456uvw",
        "playerId": "player789",
        "gameId": "game456",
        "roundsRemaining": 5,
        "valuePerRound": {
          "amount": "2.00",
          "currency": "EUR"
        },
        "status": "active",
        "createdAt": "2023-10-26T11:00:00Z",
        "expiresAt": "2023-11-26T11:00:00Z"
      }
    ]
  },
  "id": "a1a1a1a1-b2b2-c3c3-d4d4-e5e5e5e5e5e5"
}
```
```

--------------------------------

### games.list API Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/freebets-api/games-list

This JSON object illustrates a typical response from the games.list API endpoint. It contains a list of game objects, each with its unique identifier, title, description, type, and an array of valid bet amounts for the requested currency.

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "game": "KitchenDramaSushiMania",
            "title": "KitchenDramaSushiMania",
            "description": "",
            "type": "SLOT",
            "validBets": [
                0.2,
                0.4,
                0.6,
                0.8,
                1,
                2,
                4,
                6,
                8,
                10,
                20,
                40,
                60,
                80,
                100
            ]
        },
        {
            "game": "Oktoberfest",
            "title": "Oktoberfest",
            "description": "",
            "type": "SLOT",
            "validBets": [
                0.2,
                0.4,
                0.6,
                0.8,
                1,
                2,
                4,
                6,
                8,
                10,
                20,
                40,
                60,
                80,
                100
            ]
        }
    ],
    "id": "<will match unique UUID from above>"
}
```

--------------------------------

### Response Example for games.feature-list API

Source: https://docs.nolimitcity.com/docs/featurebets-api/game-feature-list

This JSON object illustrates a typical response from the 'games.feature-list' API. It contains a list of game objects, each detailing its features, including feature name, type, description, and cost multiplier. The response also includes the JSON RPC version and the matching request ID.

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
          "game": "BarbarianFury",
          "features": [
            {
              "featureName": "FREESPIN",
              "type": "FREESPIN",
              "description": "",
              "costMultiplier": 70
            }
          ]
        },
        {
          "game": "BookOfShadows",
          "features": [
            {
              "featureName": "FREESPIN_3_ROWS",
              "type": "FREESPIN",
              "description": "",
              "costMultiplier": 60
            },
            {
              "featureName": "FREESPIN_4_ROWS",
              "type": "FREESPIN",
              "description": "",
              "costMultiplier": 90
            },
            {
              "featureName": "FREESPIN_5_ROWS",
              "type": "FREESPIN",
              "description": "",
              "costMultiplier": 120
            }
          ]
        },
        {
        "game": "Deadwood",
        "features": [
          {
            "featureName": "FREESPIN",
            "type": "FREESPIN",
            "description": "",
            "costMultiplier": 71
          },
          {
            "featureName": "FREESPIN_BOUNTY",
            "type": "FREESPIN",
            "description": "",
            "costMultiplier": 750
          }
        ]
      },
    ],
    "id": "<will match unique UUID from above>"
}
```

--------------------------------

### IDENTIFICATION Object Example

Source: https://docs.nolimitcity.com/docs/featurebets-api

The IDENTIFICATION object is used to verify the correct destination for requests. It requires an OperatorName and OperatorKey, which are agreed upon values for identifying integrations and ensuring secure communication between testing and production environments.

```json
{
  "name": "OperatorName",
  "key": "OperatorKey"
}
```

--------------------------------

### Cancel Feature Bet Request Example

Source: https://docs.nolimitcity.com/docs/featurebets-api/featurebets-cancel

This JSON snippet demonstrates how to structure a request to the featurebet.cancel API method. It includes parameters for identification, the promotion name, and the user or source initiating the cancellation. The 'evict' parameter is also shown, which is a boolean indicating immediate cancellation.

```json
{
  "jsonrpc": "2.0",
  "method": "featurebet.cancel",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_API_KEY"
    },
    "promoName": "user_4b5727162-promo",
    "evict": true,
    "removedBy": "user_4b5727162"
  },
  "id": "<insert unique UUID here>"
}
```

--------------------------------

### Free Bets Cancel Response Example (JSON)

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-cancel

This JSON object illustrates a successful response from the freebets.cancel API. It confirms the request's processing by returning an empty result object and matching the request ID.

```json
{
    "jsonrpc": "2.0",
    "result": {},
    "id": "<will match UUID from above>"
}
```

--------------------------------

### Free Bets API - Introduction

Source: https://docs.nolimitcity.com/docs/freebets-api

General information about the Free Bets API, its purpose, and the use of JSON-RPC 2.0.

```APIDOC
## Free Bets API - Introduction

### Description
The free bets API allows handing out promotional rounds to players. Server-side integration is based on the JSON-RPC version 2.0 specification using the transport of posting messages over https with a set of defined methods with parameters and expected responses.

### Key Features
- Uses JSON-RPC 2.0 specification.
- Supports named parameters for requests and responses.
- Requires a unique `id` (UUID) for each call.
- Supports batch calls for incoming requests.
- Defines common objects for `IDENTIFICATION` and `MONEY`.
- Provides specific error codes for various issues.
```

--------------------------------

### Feature Bets Get

Source: https://docs.nolimitcity.com/docs/featurebets-api

Endpoint for retrieving information about feature bets.

```APIDOC
## GET /featurebets/get

### Description
This endpoint allows for the retrieval of information related to feature bets.

### Method
GET

### Endpoint
`/featurebets/get`

### Parameters
#### Query Parameters
- **playerId** (string) - Required - The unique identifier for the player.
- **bonusId** (string) - Optional - The identifier for the bonus.

### Request Example
```
GET /featurebets/get?playerId=player123&bonusId=bonusXYZ
```

### Response
#### Success Response (200)
- **featureBets** (array) - A list of feature bets.
  - **bonusId** (string) - The identifier for the bonus.
  - **bonusBuyCost** (MONEY) - The cost of the bonus buy.
    - **amount** (string) - The monetary amount.
    - **currency** (string) - The ISO 4217 currency code.

#### Response Example
```json
{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "result": [
    {
      "bonusId": "bonusXYZ",
      "bonusBuyCost": {"amount": "10.00", "currency": "EUR"}
    }
  ]
}
```
```

--------------------------------

### Fetch Multiple User Balances (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/balance

Shows how to request balances for multiple users simultaneously using the wallet.balance method. Requires operator identification and a list of userIds.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.balance",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userIds": [
      "xyz_123",
      "xyz_456"
    ]
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### Deposit API

Source: https://docs.nolimitcity.com/docs/wallet-integration

Initiates a deposit of funds into a player's account.

```APIDOC
## POST /deposit

### Description
Initiates a deposit transaction for a player, adding the specified amount to their balance.

### Method
POST

### Endpoint
/deposit

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **IDENTIFICATION** (object) - Required - Used to verify the operator making the request.
- **player_id** (string) - Required - The unique identifier for the player.
- **amount** (MONEY) - Required - The amount and currency to deposit.
- **uniqueReference** (string) - Required - A unique reference for this transaction.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "deposit",
  "params": {
    "IDENTIFICATION": {"name":"OperatorName", "key":"OperatorKey"},
    "player_id": "player123",
    "amount": {"amount":100.00, "currency":"EUR"},
    "uniqueReference": "txn67890"
  },
  "id": "some-uuid"
}
```

### Response
#### Success Response (200)
- **IDENTIFICATION** (object) - Information about the operator.
- **balance** (MONEY) - The player's balance after the deposit.
- **INFORMATION** (object) - Transaction details.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "result": {
    "IDENTIFICATION": {"name":"OperatorName", "key":"OperatorKey"},
    "balance": {"amount":150.50, "currency":"EUR"},
    "INFORMATION": {"uniqueReference":"txn67890", "time":"2023-10-27T10:05:00.000Z"}
  },
  "id": "some-uuid"
}
```
```

--------------------------------

### Jurisdiction Parameter Handling

Source: https://docs.nolimitcity.com/docs/jurisdiction

This section details how to pass jurisdiction information in the game launch URL. It explains the default behavior, the need for the 'jurisdiction' parameter for non-MGA jurisdictions, and the encoding/decoding process.

```APIDOC
## Jurisdiction Parameter Handling

### Description
This endpoint documentation describes how to pass jurisdiction information in the game launch URL. The platform defaults to MGA regulations if no jurisdiction parameter is provided. For other jurisdictions, the 'jurisdiction' parameter must be included and correctly encoded.

### Method
GET (Implied by URL parameter usage)

### Endpoint
`/game_launch_url?jurisdiction={encoded_options}`

### Parameters
#### Query Parameters
- **jurisdiction** (string) - Required - The jurisdiction tag for the desired regulatory requirements. This parameter needs to be URL-encoded.

### Request Body
N/A

### Request Example
`&jurisdiction=%7B%22name%22%3A%22UKGC%22%7D`

### Response
#### Success Response (200)
N/A (This describes URL parameter usage, not a direct API response)

#### Response Example
N/A
```

--------------------------------

### Fetch Single User Balance (JSON)

Source: https://docs.nolimitcity.com/docs/wallet-integration/balance

Demonstrates how to request the balance for a single user using the wallet.balance method. Requires operator identification and a userId.

```json
{
  "jsonrpc": "2.0",
  "method": "wallet.balance",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userId": "xyz_123"
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

--------------------------------

### MONEY Object Example

Source: https://docs.nolimitcity.com/docs/featurebets-api

The MONEY object represents monetary values, including the amount and currency. The amount is formatted as a string with a dot as the decimal separator, and the currency is specified using the ISO 4217 currency code.

```json
{
  "amount": "12345.678",
  "currency": "EUR"
}
```

--------------------------------

### POST wallet.deposit

Source: https://docs.nolimitcity.com/docs/wallet-integration/deposit

Initiates a deposit into a user's wallet. Deposits that fail are retried until successful. Ensure idempotency by checking the `uniqueReference`.

```APIDOC
## POST wallet.deposit

### Description
Initiates a deposit into a user's wallet. Deposits that fail are retried until successful. Ensure idempotency by checking the `uniqueReference`.

### Method
POST

### Endpoint
/wallet/deposit

### Parameters
#### Request Body
- **identification** (IDENTIFICATION) - Required - Operator identification details.
- **userId** (STRING) - Required - The user ID obtained from a successful token validation.
- **extId1** (STRING) - Optional - Additional information, potentially related to session or account details.
- **deposit** (MONEY) - Required - The deposit amount and currency.
- **promoName** (STRING) - Optional - Identifier for promotions associated with the deposit.
- **information** (INFORMATION) - Required - Contains unique reference, game round ID, game name, and timestamp.
- **gameResult** (STRING) - Optional - Used for Portuguese SM RESULT reporting.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "wallet.deposit",
  "params": {
    "identification": {
      "name": "Operator",
      "key": "XYZZY"
    },
    "userId": "xyz_123",
    "deposit": {
      "amount": 10.00,
      "currency": "EUR"
    },
    "information": {
      "uniqueReference": "...",
      "gameRoundId": "...",
      "game": "...",
      "time": "2016-01-02T12:34:56.789Z"
    }
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```

### Response
#### Success Response (200)
- **balance** (MONEY) - The updated balance after the deposit.
- **transactionId** (STRING) - A unique reference for the transaction from the operator's side.
- **tokens** (TOKENS) - Optional - Additional token information.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "result": {
    "balance": {
      "amount": 110.00,
      "currency": "EUR"
    },
    "transactionId": "xyz123456"
  },
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
```
```

--------------------------------

### Cancel Feature Bet Response Example

Source: https://docs.nolimitcity.com/docs/featurebets-api/featurebets-cancel

This JSON snippet shows a typical successful response from the featurebet.cancel API method. It confirms the request was processed and includes the original request ID for correlation. An empty 'result' object indicates success.

```json
{
    "jsonrpc": "2.0",
    "result": {},
    "id": "<will match unique UUID from above>"
}
```

--------------------------------

### Balance API

Source: https://docs.nolimitcity.com/docs/wallet-integration

Retrieves the current balance for a player.

```APIDOC
## POST /balance

### Description
Retrieves the current balance of a player, including currency information.

### Method
POST

### Endpoint
/balance

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **IDENTIFICATION** (object) - Required - Used to verify the operator making the request.
- **player_id** (string) - Required - The unique identifier for the player.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "getBalance",
  "params": {
    "IDENTIFICATION": {"name":"OperatorName", "key":"OperatorKey"},
    "player_id": "player123"
  },
  "id": "some-uuid"
}
```

### Response
#### Success Response (200)
- **IDENTIFICATION** (object) - Information about the operator.
- **balance** (MONEY) - An object containing the player's current balance and currency.

#### Response Example
```json
{
  "jsonrpc": "2.0",
  "result": {
    "IDENTIFICATION": {"name":"OperatorName", "key":"OperatorKey"},
    "balance": {"amount":100.50, "currency":"EUR"}
  },
  "id": "some-uuid"
}
```
```

--------------------------------

### Feature Bets API - Introduction

Source: https://docs.nolimitcity.com/docs/featurebets-api

Provides an overview of the Feature Bets API, its purpose, and the underlying communication protocol (JSON-RPC 2.0).

```APIDOC
## Introduction

The Feature Bets API allows for the distribution of promotional bonus buys to players. These bonus buys are valid for one bonus of a given type and a preset bonus buy cost.

Server-side integration is based on the JSON-RPC version 2.0 specification, using HTTPS for transport. The API defines specific methods with parameters and expected responses, exclusively using named parameters for clarity and extensibility.

Requests require a unique `id` field (UUID string) for each call. Resending a request due to an error should use a new `id`. The API supports batch calls for incoming requests.

Application error responses are expected to have a code of `-32000` within the `data` object of the error field. Other communication errors should be handled as per the JSON-RPC 2.0 specification.
```

--------------------------------

### POST /websites/nolimitcity

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-add

Used to create free bets for a player and game. This endpoint allows for the configuration of various parameters related to the free bet promotion.

```APIDOC
## POST /websites/nolimitcity

### Description
Used to create free bets for a player and game. This endpoint allows for the configuration of various parameters related to the free bet promotion.

### Method
POST

### Endpoint
/websites/nolimitcity

### Parameters
#### Request Body
- **identification** (IDENTIFICATION) - Required - See common objects above.
- **userId** (STRING) - Required - The user id that will receive the free bets.
- **promoName** (STRING) - Required - The unique identifier of the promotion. This will be sent through with the deposit wallet call.
- **game** (STRING) - Required - Game name that the promotion will be activated in.
- **rounds** (NUMBER) - Required - Number of rounds to give to the player.
- **amount** (MONEY) - Required - Value of each round.
- **expires** (STRING) - Optional - Date and time up until when the promotion can be accepted/activated by the player. If the promotion has been accepted/activated by the player before this specified date and time, the player can play the offer till the `eviction` date and time. Time to be in ISO 8601 format.
- **eviction** (STRING) - Optional - Date and time up until when the promotion is to be completely voided. This only occurs in the event that the player has activated the promo within the time/date set in `expires` field. Please note that if the `eviction` parameter is not filled in, then the player can keep playing this offer without a date and time limit and the promotion is only closed after all rounds have been played. Time to be in ISO 8601 format.

### Request Example
```json
{
  "jsonrpc": "2.0",
  "method": "freebets.add",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "userId":"user_4b5727162",
    "promoName":"user_4b5727162-promo",
    "game":"Mental",
    "rounds": 10,
    "amount": {"amount": "1", "currency":"EUR"},
    "expires": "2023-12-01T00:00:00",
    "eviction": "2023-12-31T23:59:59"
  },
  "id": "<insert unique UUID here>"
}
```

### Response
#### Success Response (200)
- **jsonrpc** (STRING) - The JSON-RPC protocol version.
- **result** (OBJECT) - An empty object indicating success.
- **id** (STRING) - The unique UUID matching the request ID.

#### Response Example
```json
{
    "jsonrpc": "2.0",
    "result": {},
    "id": "<will match unique UUID from above>"
}
```
```

--------------------------------

### Create Free Bets Request (JSON)

Source: https://docs.nolimitcity.com/docs/freebets-api/freebets-add

This JSON object demonstrates the structure for a request to the freebets.add method. It includes parameters for player identification, promotion details, game, bet value, and expiration dates.

```json
{
  "jsonrpc": "2.0",
  "method": "freebets.add",
  "params": {
    "identification": {
      "name": "OPERATOR",
      "key": "OPERATOR_SECRET_KEY"
    },
    "userId":"user_4b5727162",
    "promoName":"user_4b5727162-promo",
    "game":"Mental",
    "rounds": 10,
    "amount": {"amount": "1", "currency":"EUR"},
    "expires": "2023-12-01T00:00:00",
    "eviction": "2023-12-31T23:59:59"
  },
  "id": "<insert unique UUID here>"
}
```
Tokens:
Raw