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

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

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"
}

ErrorDetail

idstring^[0-9a-f]{8}-[0-9a-f]{4}-([34])[0-9a-f]{3}-[8...required

The randomly generated UUID identifying this errorDetail, as defined for a variant 4 UUID in RFC 4122

originalIdstring^[0-9a-f]{8}-[0-9a-f]{4}-([34])[0-9a-f]{3}-[8...

The UUID of the original request message in the case of an error occurring for an advice message

errorTypestringrequired

The type of error that occurred

Enum"DUPLICATE_RECORD""FORMAT_ERROR""FUNCTION_NOT_SUPPORTED""GENERAL_ERROR""INVALID_AMOUNT""ROUTING_ERROR""TRANSACTION_NOT_SUPPORTED""UNABLE_TO_LOCATE_RECORD""UPSTREAM_UNAVAILABLE""INVALID_PRODUCT"

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

A short description of the error

requestTypestringrequired

The type of request that preceded the error

Enum"WAGER_REQUEST""WAGER_REVERSAL""WAGER_CONFIRMATION""GET_GAME_RULES""LOOKUP_WAGER""GET_GAMES"

detailMessageobject

A free form detailed description of a particular failure condition may optionally be supplied

{
  "id": "string",
  "originalId": "string",
  "errorType": "DUPLICATE_RECORD",
  "errorMessage": "string",
  "requestType": "WAGER_REQUEST",
  "detailMessage": {}
}