Limits

Limits Endpoints

This section will display all available endpoints to get limits data.

Delete & Swap limits are not available for all brands, it depends on the regulation that they are in, please contact your account manager for more information.

Subsections of Limits

Get Limits

This method player limits. use gateway.[msdomain]

Request (GET)

/gateway/limits/{version}/player/limits/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.

Response

Status 200

{
  "active": {
    "deposit": {
      "time_frame": "undefined",
      "amount": "undefined",
      "amount_left": "undefined",
      "changed_by": null,
      "end_time": "undefined"
    },
    "loss": {
      "time_frame": "week",
      "amount": "250",
      "start_time": "2017-02-05 15:15:56.0",
      "end_time": "2017-02-05 15:15:56.0",
      "last_changed": "2017-02-05 15:15:56.0",
      "changed_by": "player",
      "amount_left": "240"
    },
    "bet": {
      "time_frame": "week",
      "amount": "250",
      "start_time": "2017-02-05 15:15:56.0",
      "end_time": "2017-02-05 15:15:56.0",
      "last_changed": "2017-02-05 15:15:56.0",
      "changed_by": "player",
      "amount_left": "240",
      "can_activate": false
    },
    "time_limit": {
      "brand_id": 1007,
      "player_id": 2,
      "time_frame": "50_minutes",
      "status": "active",
      "changed_by": "player",
      "effective_of": "2018-06-18 17:38:23"
    }
  },
  "pending": {
    "bet": {
      "time_frame": "day",
      "amount": "20",
      "start_time": "2017-02-05 15:15:56.0",
      "last_changed": "2017-02-05 15:15:56.0",
      "changed_by": "player",
      "end_time": "2017-02-05 15:15:56.0",
      "row_id": "1235842",
      "can_activate": true
    }
  },
  "reality_check": "30_min"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
active will contain list of current active limits, available types: bet, loss, deposit.
pending will contain list of current pending limits, available types: bet, loss, deposit.
reality_check will contain current reality check configuration, format XX_YY where xx will represent number and yy time frame (minute/minutes/hour/hours), player should get notified by this configuration.

Calculate Limits

This method calculates one or more pending limits for a player. use gateway.[msdomain]

Request (POST)

/gateway/limits/{version}/player/limits/calculate/{brand_id}

Parameters:

{
  "changed_by": "roman",
  "uuid": "201608120826_1",
  "loss": {
    "time_frame": "day",
    "new_amount": "200"
  },
  "bet": {
    "time_frame": "week",
    "new_amount": "1500"
  },
  "reality_check": "60_min"
}
Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.
uuid body string true unique reference.
X.time_frame body string true time frame for the chosen limit.
X.new_amount body string true amount for the chosen limit.
reality_check body string true period for the reality check.

Response

Status 200

{
  "loss": {
    "effective_of": "now",
    "time_frame": "day",
    "amount": "200",
    "amount_left": "150"
  },
  "bet": {
    "effective_of": "2017-01-18 12:00",
    "time_frame": "week",
    "amount": "1500",
    "amount_left": "1500"
  },
  "reality_check": "60_min"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
effective_of indication if limit will be effective immediately, or after some cool down.
time_frame time frame for the chosen limit.
amount amount for the chosen limit.
amount_left amount left for the chosen limit.

Update Limits

This method updates one or more of a player’s active/pending limits, need to use the result we get from Calculate Limits.

Request (PUT)

{
  "uuid": "1234",
  "loss": {
    "effective_of": "now",
    "time_frame": "day",
    "amount": "200",
    "amount_left": "150"
  },
  "bet": {
    "effective_of": "2017-01-18 12:00",
    "time_frame": "week",
    "amount": "1500",
    "amount_left": "1500"
  },
  "reality_check": "60_min"
}

/gateway/limits/{version}/player/limits/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.
effective_of body string true indication if limit will be effective immediately, or after some cool down.
time_frame body string true time frame for the chosen limit.
amount body string true amount for the chosen limit.
amount_left body string true amount left for the chosen limit.

Response

Status 202

"Updated"

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Swap Limits

This method changes a limit for a player. Use this call when a player confirms that they want to use their new, pending limit after the required 24-hour waiting period. For more information about limits

Request (PUT)

[
  "1234",
  "123"
]

/gateway/limits/{version}/player/delete/limits/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.
array body array true array containing all the ids to swap.

Response

Status 200

{
  "loss": {
    "effective_of": "now",
    "time_frame": "day",
    "amount": "200"
  },
  "bet": {
    "effective_of": "now",
    "time_frame": "week",
    "amount": "1500"
  }
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
effective_of indication if limit will be effective immediately, or after some cool down.
time_frame time frame for the chosen limit.
amount amount for the chosen limit.

Delete Limits

This method deletes one or more of a player’s pending limits, this should be used when player decides to remove his pending limits.

Request (PUT)

{
  "row_id": ["1234,123"]
}

/gateway/limits/{version}/player/delete/limits/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.
row_id body array true array containing all the ids to remove.

Response

204 Response (No Content)

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}

Limits Metadata

This method retrieves options for player limits. Use this method to populate a page that enables you to edit the limits. use gateway.[msdomain]

Request (GET)

/gateway/limits/{version}/meta-data/{brand_id}/{currency}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token path string true Player login session.
currency path string true ISO3 currency code.

Response

Status 200

{
  "deposit": {
    "amount": "no_limit",
    "period": "no_limit"
  },
  "bet": {
    "amount": "1000",
    "period": "week"
  },
  "loss": {
    "amount": "10000",
    "period": "month"
  },
  "limit_periods": [
    "day",
    "week",
    "month",
    "no_limit"
  ],
  "reality_check": {
    "period": "undefined",
    "options": [
      "15_min",
      "30_min",
      "60_min",
      "no_limit"
    ]
  }
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 401

{
  "errMsg": "invalid input - invalid token"
}

Status 500

{
  "result": "internal server error"
}