Casino 3rd Party Games Integration to RGS API 1.1 rev1.

07

Casino Third Party Games Integration to RGS API 1.1

Quick Reference
Doc rev 1.07

Copyright © 2015-2021 BetConstruct. All rights reserved.

Revision History

Rev Revision Description Approved Corrected

# Date by by

1
 1.01 12/10 Inputs proofreading. Document creating. E. Igor
/2017 Mkrtchyan Mouhsian

1.02 17/04 Ch. 6 modified, § 6.1 added, Ch. 7 FSDeposit added, Ch. E. A. Korkotyan
/2019 8 Front End added, Ch.9 Free Spins added Mkrtchyan

1.03 25/04 § 9.1 parameter descriptions edited A. A. Korkotyan

/2019 Kunjuryan

1.04 5Jun, § 9.1: a new parameter 'operatorCode' added A. I. Mukhsiyan

2019 Harutyunyan

1.05 2Aug, Contents were shifted. Ch 8 JackpotDeposit and §8.1 Error A. I. Mukhsiyan
2019 Codes inserted. Harutyunyan

1.06 04/10 In section 10.1 added "decimal" description Lilit Lilit

/2021 to automaticForfeitValue Hayrapetyan Ghazaryan

1.07 15/02 The Table of Contents was changed and added in 2.2 and Lilit Marina
/2022 2.4: Hayrapetyan Manucharova

err_code description
127 Player Limit Exceeded

Contents

Revision History
Introduction
1 Front End
2 Backend
2.1 GetPlayerInfo
2.2 Withdraw
2.3 Deposit
2.4 Withdraw/Deposit
2.5 Rollback Transaction
2.6 FSWithdraw
2.7 FSDeposit
2.8 JackpotDeposit
3 Free Spins
3.1 Free Spin Creation

Table of Contents

Introduction
This API documentation contains a description of parameters used for third-party games integration into
Remote Gaming Server (RGS).
The HTTPS POST method is used for all requests. The Content-Type of request is application/JSON. The
following parameters are general for all requests

2
 time — request time, datetime string, with "DD-MM-YYYY HH:MM:SS" format
data — JSON-encoded data, requested API method parameters
hash — MD5 checks the sum of concatenated string, which consists of PrivateKey (given to partner) time
and data.

1 Front End
Game Launch URLs for demo and real modes.
Demo mode
https://YOUR-DOMAIN.COM/xxxxxxxxx?mode=demo&gameID=YOUR_GAME_ID&language=eng
Real mode
https://YOUR-DOMAIN.COM/xxxxxxxxx?
mode=real_play&gameID=YOUR_GAME_ID&token=PLAYER_TOKEN&language=eng

2 Backend

2.1 GetPlayerInfo

Required parameter of data:

token — identifies the player.

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
currencyId — ISO currency code
totalBalance — player's balance by specified currency
nickName — player's nickname
gender — 1 - male, 0 - female
country — player`s country
userID — player's id is unique

err_code Description

8 Authentication Failed

34 Wrong Currency

84 Game is Blocked

106 Token Expired

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

3
2.2 Withdraw

Required parameters of data:

token — identifies a player

transactionId — unique key, in order to identify a single financial transaction
roundId — identifies game cycle (can be null)
gameId — identifies game
currencyId — ISO currency code
betAmount — amount to debit
betInfo — (can be used if the additional data should be sent)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
transactionId — unique key which identifies the single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

4 Wrong Bet Amount

7 Wrong Game ID

8 Authentication Failed

21 Not Enough Money

29 Player Is Blocked

34 Wrong Currency

84 Game is Blocked

104 Transaction already exists

106 Token Expired

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

127 Player Limit Exceeded

2.3 Deposit

4
Request parameters of data:

token — identifies the player

transactionId — unique key, in order to identify a single financial transaction
roundId — identifies game cycle(can be null)
gameId — identifies the game
currencyId — ISO currency code
winAmount — amount to the credit
betInfo — (can be used if the additional data should be sent)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
transactionId — unique key which identifies a single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

7 Wrong Game ID

8 Authentication Failed

34 Wrong Currency

63 Wrong Win Amount

84 Game is Blocked

104 The transaction already exists

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

2.4 Withdraw/Deposit

Required parameters of data:

token — identifies the player

transactionId — unique key, in order to identify a single financial transaction.
roundId — identifies game cycle (can be null)
gameId — identifies the game
currencyId — ISO currency code
betAmount — amount to debit
winAmount — amount to the credit
betInfo — (can be used if the additional data should be sent)

5
Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
transactionId — unique key which identifies a single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

4 Wrong Bet Amount

7 Wrong Game ID

8 Authentication Failed

21 Not Enough Money

29 Player Is Blocked

34 Wrong Currency

63 Wrong Win Amount

84 Game is Blocked

104 Transaction already exists

106 Token Expired

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

127 Player Limit Exceeded

2.5 Rollback Transaction

Request parameters of data:

token — identifies a player

transactionId — the id of the transaction to rollback
gameId — identifies the game

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)

6
 err_code — error code (if the "result" is false)
transactionId — unique key which identifies a single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

8 Authentication Failed

21 Not Enough Money

34 Wrong Currency

104 The transaction already exists

105 The transaction is already canceled

107 Transaction not found

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

Request Parameters

Parameter Type

time string

hash string

token string

transactionId string

roundId string

gameId string

currencyId string

betAmount decimal

winAmount decimal

betInfo string

Parameter Type

currencyId string

7
 totalBalance decimal

nickName string

gender int

country string

userID int

transactionId long

balance decimal

2.6 FSWithdraw

The request should be implemented for Free Spin if the withdraw is mandatory on the Provider side during Free
Spins.
Required parameters of data:

token — identifies a player

transactionId — unique key, in order to identify a single financial transaction
roundId — identifies game cycle (can be null)
gameId — identifies the game
currencyId — ISO currency code
betAmount — amount to debit
betInfo — (can be used if the additional data should be sent)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
transactionId — unique key which identifies a single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

4 Wrong Bet Amount

7 Wrong Game ID

8 Authentication Failed

21 Not Enough Money

29 Player is Blocked

34 Wrong Currency

84 Game is Blocked

8
 104 Transaction already exists

106 Token Expired

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

2.7 FSDeposit

The request is mandatory for Free Spin. The total win of Free Spins should be sent by this request.
Request parameters of data:

token — identifies the player

transactionId — unique key, in order to identify the single financial transaction
roundId — identifies game cycle (can be null)
gameId — identifies the game
currencyId — ISO currency code
winAmount — amount to the credit
betInfo — (can be used if additional data should be sent)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
transactionId — unique key which identifies the single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

7 Wrong Game ID

8 Authentication Failed

34 Wrong Currency

63 Wrong Win Amount

84 Game is Blocked

104 Transaction already exists

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

9
2.8 JackpotDeposit

The request is mandatory for Jackpot wins. By this request should be sent the Jackpot wins.

Request parameters of data:

token — identifies the player

transactionId — unique key, in order to identify the single financial transaction
roundId — identifies game cycle (can be null)
currencyId — ISO currency code
winAmount — amount to debit
betInfo — (can be used if the additional data should be send)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — (if the "result" is false)
transactionId — unique key which identifies a single financial transaction (RGS transaction ID)
balance — player balance after the transaction

err_code Description

8 Authentication Failed

34 Wrong Currency

63 Wrong Win Amount

84 Game is Blocked

104 Transaction already exists

114 Token not Found

130 General Error

200 Incorrect Parameters Passed

3 Free Spins
Free Spins Bonus is a promotional tool, which allows the player to play a specified number of free rounds in a
game. Free Spins are always played with a minimal bet specified for each game and currency and maximal
lines. During Free Spins gameplay, bets are not deducted from the player's balance, but all wins, based on the
wagering factor, are collected for the Free Spins in the Provider's system.
After all free spins are played, including wagering, if any, the Provider should send the request for adding
money to the player's balance.
The implementation of the Free Spin Bonus consists of two parts:

1. Implementing the Free Spin creating logic.

2.
10
 2. Adding new methods for sending Free Spin win and Free Spin bets, if bets are mandatory on the
provider side.

3.1 Free Spin Creation

The provider should implement a method for creating Free Spin according to the model below and provide the
endpoint.
The HTTP POST method is used for Free Spin creating requests. The Content-Type of request is application
/JSON. The following parameters are general for this request.

playerId — The ID of the player, string

operatorCode — The ID of the operator, string
currency — The currency of the player, string
externalReferenceId — The unique identifier of the request, string
freeRoundValidity — The date before which the player can receive the Free Spins, datetime string, with
"dd-MM-yyyy HH:MM:ss" format
bonusMoneyValidity — The date before which the player can use the Free Spins, datetime string, with
"dd-MM-yyyy HH:MM:ss" format
numberOfFreeRounds— Count of given Free Spins, string
gameIds — Ids of games for which the Free Spins are given, string
wagerRequirement — The value of the wagering factor. If the provider does not support it, then the
value will be 0, int.
automaticForfeitValue — Minimal bonus money value, after which the Free Spin will be canceled. This
is active only when the wagering is enabled, decimal (format – #.####, four digits after the decimal point)

Response parameters:

result — request result (true if successful and false if failed)

err_desc — error description (if the "result" is false)
err_code — error code (if the "result" is false)
referenceId — unique identifier of creating request on provider side (string)

11