Lotto Service Interface (2.0.0)

The Electrum Lotto Service Interface describes an interface for creating, confirming and reversing Lotto wagers.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
URL

https://electrum.co.za/contact

Electrum Support

support@electrum.co.za

License

Apache 2.0

Languages
Servers

https://[placeholder].dev/lotto/v2/

Lotto Game Rules Service Interface

The Lotto Game Rules Service Interface API.

Operations

Lotto Games Service Interface

The Lotto Games Service Interface API.

Operations

Lotto Wager Service Interface

The Lotto Wager Service Interface API.

Operations

Schema

GameRule

gameNamestringrequired

The name of the game.

basePriceobject(LedgerAmount)required

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

basePrice.​amountinteger(int64)required

Amount in minor denomination, e.g. R799.95 is encoded as 79995

basePrice.​currencystring[0-9]{3}required

Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710

basePrice.​ledgerIndicatorstring

Indicates whether this amount is a debit or a credit. Only required when the amount can be either a debit or a credit

Enum"DEBIT""CREDIT"
maxPriceobject(LedgerAmount)required

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

maxPrice.​amountinteger(int64)required

Amount in minor denomination, e.g. R799.95 is encoded as 79995

maxPrice.​currencystring[0-9]{3}required

Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710

maxPrice.​ledgerIndicatorstring

Indicates whether this amount is a debit or a credit. Only required when the amount can be either a debit or a credit

Enum"DEBIT""CREDIT"
minBoardsinteger(int32)>= 0

The minimum number of boards that can be played per wager.

maxBoardsinteger(int32)>= 0

The maximum number of boards that can be played per wager

minSelectionsinteger(int32)>= 0

The minimum number of selections that can be made for the primary selection.

maxSelectionsinteger(int32)>= 0

The maximum number of selections that can be made for the primary selection.

minSecondarySelectionsinteger(int32)>= 0

The minimum number of selections that can be made for the secondary selection.

maxSecondarySelectionsinteger(int32)>= 0

The maximum number of selections that can be made for the secondary selection.

selectionLowNumberstring^\d{6}$

The lowest number that can be selected. Not applicable to all games.

selectionHighNumberstring^\d{6}$

The highest number that can be selected. Not applicable to all games.

secondarySelectionLowNumberstring^\d{6}$

The lowest number that can be selected for the secondary selection. Not applicable to all games.

secondarySelectionHighNumberstring^\d{6}$

The highest number that can be selected for the secondary selection. Not applicable to all games.

isQuickPickAvailableboolean

Indicates if quick pick is available for this game.

maxDurationinteger(int32)>= 0

The maximum duration of a game.

revisionstring^[ -;=\?-Z\^-z\|~]{0,50}$required

The current revision version of the game rules. The revision is retrieved from the game provider.

ticketMessagestring^[ -;=\?-Z\^-z\|~]{0,1500}$

A message to print on tickets.

addonGamesArray of objects(AddonGame)

Returns the list of all add-on games.

{
  "gameName": "string",
  "basePrice": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "maxPrice": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "minBoards": 0,
  "maxBoards": 0,
  "minSelections": 0,
  "maxSelections": 0,
  "minSecondarySelections": 0,
  "maxSecondarySelections": 0,
  "selectionLowNumber": "string",
  "selectionHighNumber": "string",
  "secondarySelectionLowNumber": "string",
  "secondarySelectionHighNumber": "string",
  "isQuickPickAvailable": true,
  "maxDuration": 0,
  "revision": "string",
  "ticketMessage": "string",
  "addonGames": [
    { … }
  ]
}

GameRuleResponse

gameRulesArray of objects(GameRule)

The list of game rules, per game.

{
  "gameRules": [
    { … }
  ]
}

LedgerAmount

An amount object only containing value and currency, and optionally an indicator of DEBIT/CREDIT

amountinteger(int64)required

Amount in minor denomination, e.g. R799.95 is encoded as 79995

currencystring[0-9]{3}required

Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710

ledgerIndicatorstring

Indicates whether this amount is a debit or a credit. Only required when the amount can be either a debit or a credit

Enum"DEBIT""CREDIT"
{
  "amount": 0,
  "currency": "string",
  "ledgerIndicator": "DEBIT"
}
Copyright 2025 | Electrum Payments (Pty) Ltd