Games

Create Game

• Endpoint: POST /v1/game

• Description: Creates a game configuration for a profile.

• Headers:

  • Authorization: Bearer <accessToken>
  • x-signed-request: <signature>

• 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.50 to 1.00
  betPrice	number	Yes	Bet price
  simulation	boolean	Yes	If true, no persistence
  replacePreviousVersion	boolean	Yes	Overwrite active version

• Allowed gameModel values:

  • oxe-ganhei
  • tri-sortuda
  • 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": "699266427f0cebb94334404e",
    "version": 1,
    "gameModel": "frevo-da-sorte",
    "active": true,
    "totalAmount": 1500000,
    "totalDistribuitionAmount": 900000,
    "totalPrized": 1000000,
    "totalLevels": 8,
    "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, 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,
      "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/{gameModel}

• Description: Activates or deactivates a game model.

• Headers:

  • Authorization: Bearer <accessToken>
  • x-signed-request: <signature>

• Path Params: gameModel

• 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