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

EncryptedPin

A PIN required to authorise a transaction. EncryptionParameters should be provided where the service will be performing operations on the encrypted PIN, such as PIN translation. Only the PIN block need be provided where the service is expected to forward it to a third party, where the calling client and said third party have agreed upon encryption parameters beforehand.

pinBlockstring[a-fA-F0-9]{16}|[a-fA-F0-9]{32}required

Hexadecimal string representing the encrypted PIN to be used.

encryptionParametersobject(EncryptionParameters)

Parameters pertaining to the generation of the PIN block. Required if the service is to perform any operations on the encrypted PIN, such as translation.

{
  "pinBlock": "string",
  "encryptionParameters": {
    "pinBlockFormat": "ISO_9564_FORMAT_0",
    "accountNumber": "string",
    "keyIndex": 0
  }
}

EncryptionParameters

Parameters pertaining to the generation of the PIN block. Required if the service is to perform any operations on the encrypted PIN, such as translation.

pinBlockFormatstring

PIN block format that was used when encrypting the PIN. Defaults to ISO_9564_FORMAT_0.

Default "ISO_9564_FORMAT_0"

Enum"ISO_9564_FORMAT_0""ISO_9564_FORMAT_1""ISO_9564_FORMAT_3""ISO_9564_FORMAT_4"

accountNumberstring[0-9]{12}required

12 digit account number used when encrypting the PIN. When account number is a card number (PAN), this is the rightmost 12 digits excluding the check digit.

keyIndexinteger(int32)

Index of the key under which the PIN block is encrypted. Where keys are exchanged in TR-31 KeyBlock format, this should be set to the key version number field of the key used for encryption. If this field is not populated, the most recently exchanged key will be used. Note that omitting this field may require a higher level of synchronization during automated key exchange in some environments.

{
  "pinBlockFormat": "ISO_9564_FORMAT_0",
  "accountNumber": "string",
  "keyIndex": 0
}

HashedPinParameters

A collection of parameters required to reliably reproduce the hashed value (excluding the actual PIN value).

namestring[ 0 .. 20 ] charactersrequired

The name of the hashing algorithm.

{
  "name": "string"
}