Bonus Validation

This method validates the parameters of a bonus. use gateway.[msdomain]
This document contains documentation for API version 1 and 2

Request (GET)

/gateway/bonus/{version}/validate/{brand_id}/{coupon}

Parameters:

Name In Type Required Description
version path string true The API version to use.
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.
coupon path string true Bonus code.
btag query string false Player affiliation reference.
currency query string false Player currency.

Response

Status 200

{
  "frb_at_registration": [
    {
      "language": "de",
      "text": "7 Freispiele für Groove_PlayNGo",
      "wagering": "null3"
    }
  ],
  "bonus_at_registration": 100,
  "frb_at_verification": [
    {
      "language": "de",
      "text": "7 Freispiele für Groove_PlayNGo",
      "wagering": "null3"
    }
  ],
  "bonus_at_verification": 30
}

Status 400

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

Status 400

{
  "status": "error",
  "data": "coupon time exceeded"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
frb_at_registration Array which will contain all available languages for FRB bonus which will be given upon registration, need to choose the relevant language for player (frb_at_registration.language) and show its text.
frb_at_verification Array which will contain all available languages for FRB bonus which will be given upon email verification, need to choose the relevant language for player (frb_at_verification.language) and show its text.
bonus_at_registration Amount which will be awarded to player once he completes the registration, please not that if currency is not sent, amount will be displayed in brand default currency.
bonus_at_verification Amount which will be awarded to player once he verifies his email, please not that if currency is not sent, amount will be displayed in brand default currency.

API VERSION 2

Request (GET)

/gateway/bonus/{version - should be >= 2}/validate/{brand_id}/{coupon}

Parameters:

Name In Type Required Description
version path string true The API version to use.
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.
coupon path string true Bonus code.
btag query string false Player affiliation reference.
currency query string false Player currency.

Response

Status 200

{
  "registration": {
    "bonus_amount": 1000,
    "wagering_multiplier": 10,
    "frb": [
      {
        "round_count": 25,
        "game_provider": "Betsoft",
        "supported_games": [
          "Primal Wilderness"
        ],
        "wagering_multiplier": 1
      }
    ]
  },
  "verification": {
    "bonus_amount": 10000,
    "wagering_multiplier": 50,
    "frb": [
      {
        "round_count": 10,
        "game_provider": "Pragmatic Play",
        "supported_games": [
          "Floating Dragon Megaways",
          "John Hunter and the Book of Tut Respin™"
        ],
        "wagering_multiplier": 1
      },
      {
        "round_count": 3,
        "game_provider": "Evoplay",
        "supported_games": [
          "Fruit Super Nova 100"
        ],
        "wagering_multiplier": 3
      },
      {
        "round_count": 44,
        "game_provider": "Betsoft",
        "supported_games": [
          "7 Fortune Frenzy",
          "At The Movies",
          "Book of Helios",
          "Dragon Kings NJP"
        ],
        "wagering_multiplier": 3
      }
    ]
  }
}

Status 200, No frb

{
  "registration": {
    "bonus_amount": 1000,
    "wagering_multiplier": 10 
  },
  "verification": {
    "bonus_amount": 10000,
    "wagering_multiplier": 50 
  }
}

Status 400

{
  "status": "Error",
  "data": "",
  "message": "coupon not found",
  "userFriendlyMessage": "coupon not found"
}

Status 500

{
  "error": "internal server error",
  "requestID": "91d3236d-82fe-4c4d-b01c-ea07ffe15af7"
}