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

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

GamesResponse

gamesArray of strings

The list of game names.

{
  "games": [
    "string"
  ]
}

Amounts

Amounts which make up the transaction. Absent amounts have zero value.

requestAmountobject(LedgerAmount)

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

approvedAmountobject(LedgerAmount)

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

feeAmountobject(LedgerAmount)

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

balanceAmountobject(LedgerAmount)

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

additionalAmountsobject

Any additional amounts that are involved in a transaction which don't appropriately fit into the other amount fields.

{
  "requestAmount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "approvedAmount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "feeAmount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "balanceAmount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "additionalAmounts": {
    "property1": { … },
    "property2": { … }
  }
}
Copyright 2025 | Electrum Payments (Pty) Ltd