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

Wager

The details of the wager which was placed.

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

The drawId of the draw the Wager pertains to. If the Wager spans multiple draws this will be the drawId of the first draw the Wager pertains to.

durationinteger(int32)>= 0

The number of draws this Wager pertains to.

gameNamestring

The name of the game this Wager pertains to.

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

An alternative indication of the wager's game.

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

The serial number of the ticket representing this Wager.

securityCodestring

The security code needed to validate the ticket representing this Wager.

boardsArray of objects(Board)required

The collection of Boards which make up the Wager.

boards[].​quickPickbooleanrequired

Boolean indicating whether or not the selections are determined by the Lotto operator.

boards[].​selectionsArray of strings

The outcome of a draw which will allow the customer to win a monetary prize.

boards[].​boardAmountinteger(int64)

The monetary value of the board.

boards[].​betTypestring

An indication of how the board is to match the three digit number drawn by the Lotto operator. This is only used for the Pick3 game.

Enum"STRAIGHT""BOX3""BOX6""FRONT2""BACK2""SPLIT"
boards[].​systemBetTypestring

An indication of how varied the results of a QuickPick selection may be.

Enum"NONE""FREE""IQP4""IQP8""IQP16""IQP24""IQP32""IQP64""IQP128""IQP256"
groupMemberIdstring^[ -;=\?-Z\^-z\|~]{0,50}$

Required to be printed on the receipt.

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

Required to be printed on the receipt.

drawStartDatestring(date-time)

The date and time of the first draw covered by this wager. The format shall be as defined for date-time in RFC 3339 section 5.6.

drawEndDatestring(date-time)

The date and time of the last draw covered by this wager. The format shall be as defined for date-time in RFC 3339 section 5.6.

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

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

{
  "drawId": "string",
  "duration": 0,
  "gameName": "string",
  "barcode": "string",
  "serialNumber": "string",
  "securityCode": "string",
  "boards": [
    { … }
  ],
  "groupMemberId": "string",
  "groupId": "string",
  "drawStartDate": "2019-08-24T14:15:22Z",
  "drawEndDate": "2019-08-24T14:15:22Z",
  "revision": "string"
}

WagerResponse

The payload of a successful wager response.

transactionLabelsArray of objects(TransactionLabel)

A list containing labels that can be used to discover this transaction or group it with other transactions sharing labels with the same label name and value. Transaction labels should never be used to make transaction processing decisions.

idstringrequired

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

timestring(date-time)required

The date and time of the message as recorded by the sender. The format shall be as defined for date-time in RFC 3339 section 5.6. It is recommended that the optional time-secfrac be included up to millisecond precision

originatorobject(Originator)required

The Originator object encapsulates data relating to the originator of the transaction

originator.​institutionobject(Institution)required

Originating, acquiring, processing, or receiving institution details

originator.​institution.​idstringrequired

The institution's ID. API implementations should take care to set this field as appropriate for the implementation.

originator.​institution.​namestring[ 0 .. 40 ] charactersrequired

The institutions's name

originator.​terminalIdstring= 8 charactersrequired

The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices

originator.​merchantobject(Merchant)required

Merchant related data. Must be included if available

originator.​merchant.​merchantTypestring[0-9]{4}required

The assigned four digit merchant category code

originator.​merchant.​merchantIdstring= 15 charactersrequired

The assigned merchant identifier. Also known as card acceptor id

originator.​merchant.​merchantNameobject(MerchantName)required

A container object representing the Merchant Name and Location

originator.​merchant.​merchantName.​namestring[ 0 .. 23 ] charactersrequired

The merchant or trading as name associated with the merchant

originator.​merchant.​merchantName.​citystring[ 0 .. 13 ] charactersrequired

The city where the merchant is located

originator.​merchant.​merchantName.​regionstring[ 0 .. 2 ] charactersrequired

The state or region where the merchant is located

originator.​merchant.​merchantName.​countrystring[ 0 .. 2 ] charactersrequired

The country where the merchant is located

originator.​operatorIdstring[ 0 .. 30 ] characters

The ID that uniquely identifies the person operating the terminal specified by the terminalId field.

originator.​channelIdstring[ 0 .. 50 ] characters

The ID that uniquely identifies the originator's channel that this transaction was received through.

clientobject(Institution)required

Originating, acquiring, processing, or receiving institution details

client.​idstringrequired

The institution's ID. API implementations should take care to set this field as appropriate for the implementation.

client.​namestring[ 0 .. 40 ] charactersrequired

The institutions's name

settlementEntityobject(Institution)

Originating, acquiring, processing, or receiving institution details

receiverobject(Institution)

Originating, acquiring, processing, or receiving institution details

thirdPartyIdentifiersArray of objects(ThirdPartyIdentifier)required

An array of identifiers which each identify the transaction within each entity's system.

thirdPartyIdentifiers[].​institutionIdstringrequired

The entity's institution ID.

thirdPartyIdentifiers[].​transactionIdentifierstringrequired

The identifier assigned to this transaction by the institution represented in institutionId. This value should be unique within the institution's system.

slipDataobject(SlipData)

Data that may be printed on the customer slip for information purposes

basketRefstring

Used to group multiple transactions which would otherwise be considered independent.

tranTypestring

Indicates the transaction type (i.e. Goods and Services or Cash Withdrawal).

Enum"GOODS_AND_SERVICES""CASH_WITHDRAWAL""DEBIT_ADJUSTMENT""GOODS_AND_SERVICES_WITH_CASH_BACK""NON_CASH""RETURNS""DEPOSIT""CREDIT_ADJUSTMENT""GENERAL_CREDIT""AVAILABLE_FUNDS_INQUIRY"
srcAccTypestring

Indicates the type of account being used in a transaction process.

Enum"DEFAULT""SAVINGS""CHEQUE""CREDIT""UNIVERSAL""ELECTRONIC_PURSE""GIFT_CARD""STORED_VALUE"
destAccTypestring

Indicates the type of account being used in a transaction process.

Enum"DEFAULT""SAVINGS""CHEQUE""CREDIT""UNIVERSAL""ELECTRONIC_PURSE""GIFT_CARD""STORED_VALUE"
stanstring

The System Trace Audit Number can be used to locate transactions across different systems.

rrnstring

This is a reference set by the original source of the transaction.

amountsobject(Amounts)

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

wagerobject(Wager)required

The details of the wager which was placed.

wager.​drawIdstring^[ -;=\?-Z\^-z\|~]{0,50}$

The drawId of the draw the Wager pertains to. If the Wager spans multiple draws this will be the drawId of the first draw the Wager pertains to.

wager.​durationinteger(int32)>= 0

The number of draws this Wager pertains to.

wager.​gameNamestring

The name of the game this Wager pertains to.

wager.​barcodestring^[ -;=\?-Z\^-z\|~]{0,50}$

An alternative indication of the wager's game.

wager.​serialNumberstring^[ -;=\?-Z\^-z\|~]{0,50}$

The serial number of the ticket representing this Wager.

wager.​securityCodestring

The security code needed to validate the ticket representing this Wager.

wager.​boardsArray of objects(Board)required

The collection of Boards which make up the Wager.

wager.​boards[].​quickPickbooleanrequired

Boolean indicating whether or not the selections are determined by the Lotto operator.

wager.​boards[].​selectionsArray of strings

The outcome of a draw which will allow the customer to win a monetary prize.

wager.​boards[].​boardAmountinteger(int64)

The monetary value of the board.

wager.​boards[].​betTypestring

An indication of how the board is to match the three digit number drawn by the Lotto operator. This is only used for the Pick3 game.

Enum"STRAIGHT""BOX3""BOX6""FRONT2""BACK2""SPLIT"
wager.​boards[].​systemBetTypestring

An indication of how varied the results of a QuickPick selection may be.

Enum"NONE""FREE""IQP4""IQP8""IQP16""IQP24""IQP32""IQP64""IQP128""IQP256"
wager.​groupMemberIdstring^[ -;=\?-Z\^-z\|~]{0,50}$

Required to be printed on the receipt.

wager.​groupIdstring^[ -;=\?-Z\^-z\|~]{0,50}$

Required to be printed on the receipt.

wager.​drawStartDatestring(date-time)

The date and time of the first draw covered by this wager. The format shall be as defined for date-time in RFC 3339 section 5.6.

wager.​drawEndDatestring(date-time)

The date and time of the last draw covered by this wager. The format shall be as defined for date-time in RFC 3339 section 5.6.

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

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

paymentMethodsArray of objects(PaymentMethod)

An array of payment methods to be used as payment for the transaction. This is used if payment is not tendered at the point of sale, but is effected through one or more calls to third party payment providers as part of the request. A PaymentMethod differs from a Tender in that the former represents payment that still needs to be collected from a third party, whereas the latter represents payment that has already been collected at the point of sale.

{
  "transactionLabels": [
    { … }
  ],
  "id": "string",
  "time": "2019-08-24T14:15:22Z",
  "originator": {
    "institution": { … },
    "terminalId": "stringst",
    "merchant": { … },
    "operatorId": "string",
    "channelId": "string"
  },
  "client": {
    "id": "string",
    "name": "string"
  },
  "settlementEntity": {
    "id": "string",
    "name": "string"
  },
  "receiver": {
    "id": "string",
    "name": "string"
  },
  "thirdPartyIdentifiers": [
    { … }
  ],
  "slipData": {
    "messageLines": [ … ],
    "slipWidth": 0,
    "issuerReference": "string"
  },
  "basketRef": "string",
  "tranType": "GOODS_AND_SERVICES",
  "srcAccType": "DEFAULT",
  "destAccType": "DEFAULT",
  "stan": "string",
  "rrn": "string",
  "amounts": {
    "requestAmount": { … },
    "approvedAmount": { … },
    "feeAmount": { … },
    "balanceAmount": { … },
    "additionalAmounts": { … }
  },
  "wager": {
    "drawId": "string",
    "duration": 0,
    "gameName": "string",
    "barcode": "string",
    "serialNumber": "string",
    "securityCode": "string",
    "boards": [ … ],
    "groupMemberId": "string",
    "groupId": "string",
    "drawStartDate": "2019-08-24T14:15:22Z",
    "drawEndDate": "2019-08-24T14:15:22Z",
    "revision": "string"
  },
  "paymentMethods": [
    { … }
  ]
}

WalletPayment

Base model for all payment types

typestringrequired

The general method of payment used

Enum"AN_32_TOKEN""LOYALTY_CARD""CARD""ACCOUNT""REWARD""WALLET""QR"
Discriminator
namestring

The specific method of payment used

amountobject(LedgerAmount)

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

issuerobject(Institution)

Originating, acquiring, processing, or receiving institution details

pinobject(Pin)

Base model for capturing either a clear PIN or encrypted PIN

proxystring[ 0 .. 40 ] characters

An alternative identifier for the customer's source of funds. Acts as a stand in for the customer identifier. E.g. a customer's MSISDN or email address.

proxyTypestring

An enumerated value describing the type of value used as the proxy.

Enum"MSISDN""EMAIL""UNKNOWN"
tokenstring[a-zA-Z0-9]{32}required

32 character alphanumeric code which identifies a token

{
  "type": "AN_32_TOKEN",
  "name": "string",
  "amount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "issuer": {
    "id": "string",
    "name": "string"
  },
  "pin": {
    "type": "CLEAR_PIN"
  },
  "proxy": "string",
  "proxyType": "MSISDN",
  "token": "string"
}
Copyright 2025 | Electrum Payments (Pty) Ltd