Games

Create Game

• Endpoint: POST /v1/game

• Description: Creates a game configuration for a profile.

• Headers:

  • Authorization: Bearer <accessToken>
  • x-signed-request: <signature>
  • Content-Type: application/json

• Body:

  Field	Type	Required	Description
  profileId	string	Yes	Profile ID
  gameModel	string	Yes	See allowed models below
  lang	string	Yes	ISO 639-1
  currency	string	Yes	ISO 4217
  rtp	number	Yes	0.50 to 0.95
  sampling	number	Yes	Sample size. above 100,000
  prizedPercent	number	Yes	0.20 to 1.00 - percentage of the sample that will be awarded
  betPrice	number	Yes	Bet/ticket price
  simulation	boolean	Yes	If true, no persistence, only return game info
  replacePreviousVersion	boolean	Yes	Overwrite active version

• Allowed gameModel values:

  • oxe-ganhei
  • trem-de-ouro-v1
  • trem-de-ouro-v2
  • trem-de-ouro-v3
  • frevo-da-sorte
  • bumba-meu-green
  • fera-sortuda

• Success Response (201):

{
    "status": "success",
    "data": {
        "id": "699480402888630de17ad46a",
        "version": 1,
        "gameModel": "frevo-da-sorte",
        "active": true,
        "totalAmount": 1500000,
        "totalDistribuitionAmount": 900000,
        "totalPrized": 1000000,
        "totalLevels": 8,
        "levels": [
            {
                "level": 1,
                "winners": 1,
                "totalPrize": 112500,
                "prize": 112500,
                "percentage": 0.125
            },
            {
                "level": 2,
                "winners": 10,
                "totalPrize": 112500,
                "prize": 11250,
                "percentage": 0.125
            },
            {
                "level": 3,
                "winners": 100,
                "totalPrize": 112500,
                "prize": 1125,
                "percentage": 0.125
            },
            {
                "level": 4,
                "winners": 1000,
                "totalPrize": 112500,
                "prize": 112.5,
                "percentage": 0.125
            },
            {
                "level": 5,
                "winners": 62430,
                "totalPrize": 112500,
                "prize": 1.8020182604517059,
                "percentage": 0.125
            },
            {
                "level": 6,
                "winners": 104051,
                "totalPrize": 112500,
                "prize": 1.0812005651074954,
                "percentage": 0.125
            },
            {
                "level": 7,
                "winners": 208102,
                "totalPrize": 112500,
                "prize": 0.5406002825537477,
                "percentage": 0.125
            },
            {
                "level": 8,
                "winners": 624306,
                "totalPrize": 112499.99999999999,
                "prize": 0.18020009418458255,
                "percentage": 0.125
            }
        ]
    }
}

• Errors: 400, 401, 403, 409, 500

List Games

• Endpoint: GET /v1/game

• Description: Lists games for a profile.

• Headers: Authorization: Bearer <accessToken>

• Query Params:

  Field	Type	Required	Description
  profileId	string	Yes	Profile ID

• Success Response (200):

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "gameModel": "oxe-ganhei",
      "lang": "pt",
      "currency": "BRL",
      "rtp": 0.7,
      "maxBetPrize": 150000,
      "sampling": 1500000,
      "prizedPercent": 0.95,
      "betPrice": 3,
      "version": 2,
      "active": true,
      "mediaUrl": "https://frevo-da-sorte.play.xigsapi.com/cover-image.png",
      "levels": [
            {
                "level": 1,
                "winners": 1,
                "totalPrize": 150000,
                "prize": 150000,
                "percentage": 0.25
            },
            {
                "level": 2,
                "winners": 10,
                "totalPrize": 180000,
                "prize": 18000,
                "percentage": 0.2
            },
            ...
            {
                "level": 7,
                "winners": 200000,
                "totalPrize": 54000,
                "prize": 0.27,
                "percentage": 0.06
            },
            {
                "level": 8,
                "winners": 738889,
                "totalPrize": 111000,
                "prize": 0.15,
                "percentage": 0.04
            }
        ]
    }
  ]
}

• Errors: 400, 401, 403, 500

Update Game Status

• Endpoint: PUT /v1/game/{id}

• Description: Activates or deactivates a game model.

• Headers:

  • Authorization: Bearer <accessToken>
  • x-signed-request: <signature>
  • Content-Type: application/json

• Path Params: id

• Body:

  Field	Type	Required	Description
  active	boolean	Yes	Set active status
  profileId	string	Yes	Profile ID

• Success Response (200):

{ "status": "success" }

• Errors: 400, 401, 403, 404, 500