Skip to main content

CreateNewGameRequest

cIDuuidrequired

Client's ID. It's provided by Swipe Games and is used as your identifier.

extCIDstringrequired

External Client's ID (client/platform/game aggregator/integrator or casino on your side). This is provided from your side, and this is how you identify your clients. We use it in all callbacks to you.

Example: your_ext_id
gameIDstringrequired

Game's ID. This is Swipe Games's game identifier. See the list of supported games in Games section.

Example: sg_catch_97
sessionIDstring

Session ID (external). This is your own Session ID, generated on your side. We store it and echo it back in all callbacks to you. Not required for demo games, since we don't use callbacks for demo games.

Note: this is NOT the same as the gsID (Game Session ID) returned in the response — gsID is Swipe Games's own identifier for the game session and is unrelated to the value you send here.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
returnURLstring

Return URL which we could use to redirect the user after the game is finished/exited. If you don't provide this URL, return button in the game will be disabled. Please make sure you provide this URL when using redirect to open the game, otherwise player cannot go back to your site.

Example: https://your-site.com/game-lobby
depositURLstring

Deposit URL which we could use to open a deposit page for the user. If you don't provide this URL, deposit flow in the game will be disabled.

Example: https://your-site.com/deposit
currencystringrequired

Currency code in ISO4217.

Example: USD
localestringrequired

Locale code in IETF BCP 47 format (ISO 639-1 language code with optional ISO 3166-1 country code), using underscore as separator. See Locales for the list of supported locales. If the requested locale is not supported the request fails with 400 locale_not_supported, unless fallbackToDefaultLocale is set (see below).

Example: en_us
fallbackToDefaultLocaleboolean

If true and the requested locale is not supported, the game is created with the default locale (en_us) instead of returning a 400 locale_not_supported error. Defaults to false.

Default value: false
Example: false
platformPlatformType (string)required

Platform code. This is used to identify the platform where the game is launched.

Possible values: [desktop, mobile]

Example: desktop
demobooleanrequired

Demo mode. If true, the game will be launched in demo mode (means no callbacks will be fired on your side, and we use our demo balance for the game). If false, the game will be launched in real mode.

initDemoBalancestring

Initial demo balance for the user (in currency units). Only used in demo mode (demo: true), ignored in real mode. Must be greater than the game's minimum bet, otherwise the request fails with 400. If omitted, the demo balance defaults to 10 000 USD converted into the requested currency.

Applied once, when the demo balance is created. The demo balance is stored per (cID, extCID, user.id, currency). initDemoBalance is used only when no demo balance exists yet for that combination.

For an existing user the value is ignored. If the user already has a demo balance for the same cID, extCID and currency, the game starts with the balance left from the previous demo games. Sending a different initDemoBalance does not reset, top up, or overwrite that balance.

There is no Public API operation to change the demo balance after it is created. To start a demo game from a specific balance, send a user.id that has no demo balance yet for this currency, or omit user — for demo games we generate a new user ID on every call, so initDemoBalance always applies.

Example: 10000.00
user object

User information we show in the game. User should be provided for real game.

idstringrequired

User's ID (external). This is User's ID on your side.

firstNamestring
lastNamestring
nickNamestring
countrystring

Country code ISO 3166-1 alpha-2.

CreateNewGameRequest
{
  "cID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "extCID": "your_ext_id",
  "gameID": "sg_catch_97",
  "sessionID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "returnURL": "https://your-site.com/game-lobby",
  "depositURL": "https://your-site.com/deposit",
  "currency": "USD",
  "locale": "en_us",
  "fallbackToDefaultLocale": false,
  "platform": "desktop",
  "demo": true,
  "initDemoBalance": "10000.00",
  "user": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "country": "string"
  }
}