Start Game

This method sends a request to start a new game. use gateway.[msdomain]

Request (POST)

/gateway/games/{version}/start-game/{brand_id}/{game_id}/{lang}

Parameters:

{
  "auth_token": "string",
  "return_url": "string"
}
Name In Type Required Description
brand_id path string true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
version path string true API version.
auth_token body string true Player login session.
return_url body string true Indication to where need to return when players closes the game.

Response

Status 200

{
  "html": "",
  "htmlIndicator": false,
  "provideRC": false,
  "isIframe": false,
  "game_url": "",
  "game_html": ""
}

Status 303

{
  "html": "",
  "htmlIndicator": false,
  "provideRC": false,
  "isIframe": false,
  "game_url": "",
  "game_html": "",
  "game_provider": "Groove_Nolimit",
  "result": "ggr_game",
  "real_balance": 22.22
}

Status 400

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

401 Response, in case of some addition requirement needed before proceeding

Error Code Description
INCOMPLETE_REGISTRATION The player did not complete his registration process, need to complete Registration Step Two.
TNC_APPROVAL_REQUIRED Player need to approve TnC.
PRIVACY_APPROVAL_REQUIRED Player need to approve Privacy Policy.
PASSWORD_CHANGE_REQUIRED Player has temp password and need to Change Password.
EMAIL_NOT_VERIFIED Player email is not verified and cannot continue any process till he verifies his mail.
{
  "result": "INCOMPLETE_REGISTRATION"
}

Status 403

{
  "game_id": "",
  "html": "sdf",
  "htmlIndicator": false,
  "open_game_id": 123123,
  "result": "open_round_message",
  "game_url": "sdfsdf"
}

Status 403

{
  "result": "restricted_country"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
html Game launch url, if platform is desktop, will be wrapped in iframe.
htmlIndicator indication if platform is desktop.
provideRC indication if RC check should be performed on our side, if yes, need to continue to call player status.
isIframe indication if game can be opened in iframe(in mobile).
game_url uri for game launch without iframe.
game_html Game launch url, if platform is desktop, will be wrapped in iframe.
real_balance For GGR games, indication on how much money he can actually play in game, please not that NOT ALL that on some cases, not all real money is available in game.