Reward API

• Requests and responses contain the header Content-Type: application/json
• All requests passed from/to the Operator’s system have a signature header, except options.
• Request Direction: Operator => Veligames

FreeBet Options

Request

Using this method Operator can retrieve available config options per providerId

OPTIONS /free-bet

Response

{
  "freeBetOptions": {
    "pragmatic": {
      "betAmount": [{ "fieldName": "betAmount", "required": true }],
      "betPerLineAmount": [
        { "fieldName": "betPerLineAmount", "required": true },
        { "fieldName": "lines", "required": false }
      ]
    },
    "veliplay": {
      "betLevel": [{ "fieldName": "betLevel", "required": true }]
    },
    "spribe": {
      "betAmount": [{"fieldName": "betAmount", "required": true}]
    }
  }
}

Assign FreeBet

Request

Using this method Operator can assign free bet to a player.

POST /free-bet/assign

Property	Type	Description	Required
freeBetId	string	One-time unique identifier generated by OPERATOR	Yes
providerId	string	Identifier of the game provider	Yes
gameId	string	Identifies specific game	Yes
playerId	string	Identifier of the player	Yes
currency	string	Player's ISO 4217 currency code. Examples: EUR, USD	Yes
brandId	string	Casino Brand Identifier	Yes
endDate	string	Free bets end date (timezone UTC)	Yes
quantity	string	Free bets quantity assigned to a player	Yes
config	object	Required/Optional fields and values are based on providerId and should be checked according to freeBetOptions	Yes
config.betAmount	number	Bet amount per spin	No
config.betLevel	number	Bet Level	No
config.betPerLineAmount	number	Amount of bet per line (Relevant for some slot games)	No
config.lines	number	Total Bet will be calculated by other fields * lines, for example betPerLineAmount * lines	No, Default 1
config.denomination	number	Bet denomination, If set to null, the default number will be used based on selected game.	No
config.coins	number	Number of coins. Must match the number of coins available in the selected game. If set to null, the default number of coins will be used.	No

Response

Property	Type	Description	Required
acknowledged	boolean	true if no error	Yes

Error Protocol

warning

Veligames will asynchronously request provider to assign a freebet. Success response does not guarantee you will not get an ERROR status callback. This is pre-provider validation protocol.

Property	Type	Description	Required
error	ErrorType	Error Code if something went wrong with the request	yes
details	object [fieldName]: 'error description'	Error description	No

Cancel FreeBet

Request

Using this method Operator can cancel existing free bet of a player.

POST /free-bet/cancel

Property	Type	Description	Required
freeBetId	string	Previously assigned unique identifier generated by OPERATOR	Yes
brandId	string	Casino Brand Identifier	Yes

Response

Property	Type	Description	Required
acknowledged	boolean	true if no error	Yes

Error Protocol

warning

Veligames will asynchronously request provider to cancel a freebet. Success response does not guarantee you will not get an ERROR status callback. This is pre-provider validation protocol.

Property	Type	Description	Required
error	ErrorType	Error Code if something went wrong with the request	yes
details	object [fieldName]: 'error description'	Error description	No

FreeBet Info

Request

Using this method Operator can get information about the existing free bet of a player and get its status.

POST /free-bet/info

Property	Type	Description	Required
freeBetId	string	Previously assigned unique identifier generated by OPERATOR	Yes
brandId	string	Casino Brand Identifier	Yes

Response

Property	Type	Description	Required
freeBetId	string	One-time unique identifier generated by OPERATOR	Yes
brandId	string	Casino Brand Identifier	Yes
status	string	CREATED, ASSIGNED, CANCELLED, ERROR, PLAYED (status will be changed to PLAYED as soon as we receive first win for that freebet. Freebet can not be cancelled after PLAYED status is assigned)	Yes
reason	string	Relevant if status=ERROR	No

FreeBet Status Event

• Request Direction: Veligames => Operator

POST [operator-defined-base-url]/status

Request

Property	Type	Description	Required
freeBetId	string	One-time unique identifier generated by OPERATOR	Yes
brandId	string	Casino Brand Identifier	Yes
operationType	enum	ASSIGN, CANCEL	Yes
status	string	ASSIGNED, CANCELLED, ERROR	Yes
reason	string	Relevant if status=ERROR	No

Response

HttpCode 200

Error Types

ErrorType	Status Code	Description
UNKNOWN_ERROR	500	General error, internal server error
BAD_REQUEST	400	Missing/invalid parameters
UNAUTHORIZED	401	Invalid signature
FREE_BET_EXISTS	409	Free bet exists (Assign)
FREE_BET_NOT_FOUND	404	Free bet not found (Cancel/Info)
NOT_ALLOWED	405	For example cancel not allowed. (Cancel/Assign)