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

ThreeDSecureDataV2

Data used to facilitate and communicate the result of 3-D Secure cardholder authentication.

authenticationValuestring

A 20-byte value that has been Base64 encoded. This value is provided by the Access Control Server as a proof of authentication.

cardHolderAuthVerificationResultstring

Authentication outcome set by the Access Control Server or Issuer.

Enum"CAVV_VALIDATION_PASSED""CAVV_VALIDATION_FAILED_ISSUER_SYSTEM_ERROR""CAVV_VALIDATION_FAILED_ISSUER_ATTEMPT_INCOMPLETE""CAVV_NOT_VALIDATED""CAVV_NOT_VALIDATED_INVALID_DATA""CAVV_VALIDATION_FAILED"

versionstringrequired

The version of the 3-D Secure protocol that was used for cardholder authentication. Note that the version determines the format of the transaction identifier

Enum"V1""V2"

Discriminator

ecistring

Electronic Commerce Indicator. This is Payment System-specific value provided by the Access Control Server to indicate the results of the attempt to authenticate the Cardholder.

Enum"AUTHENTICATION_NOT_ATTEMPTED_OR_UNSUCCESSFUL_00""AUTHENTICATION_NOT_ENABLED_01""AUTHENTICATION_SUCCESSFUL_02""AUTHENTICATION_SUCCESSFUL_05""AUTHENTICATION_NOT_ENABLED_06""AUTHENTICATION_NOT_ATTEMPTED_OR_UNSUCCESSFUL_07"

transactionStatusstring

Indicates whether a transaction qualifies as an authenticated transaction or account verification. The values and their meanings are as follows: Y = Authentication Verification Successful. N = Not Authenticated /Account Not Verified; Transaction denied. U = Authentication/ Account Verification Could Not Be Performed; Technical or other problem. A = Attempts Processing Performed; Not Authenticated/ Verified, but a proof of attempted authentication/verification is provided. C = Challenge Required; Additional authentication is required using the CReq/CRes D = Challenge Required; Decoupled Authentication confirmed. R = Authentication/ Account Verification Rejected; Issuer is rejecting authentication/verification and request that authorisation not be attempted. I = Informational Only; 3DS Requestor challenge preference acknowledged. S = Challenge using SPC

Enum"Y""N""U""A""C""D""R""I""S"

transactionIdstring

A 20-byte base 64 encoded string assigned by the 3DS Server to identify a single transaction. This ID can be used to prevent transaction replay.

{
  "authenticationValue": "string",
  "cardHolderAuthVerificationResult": "CAVV_VALIDATION_PASSED",
  "version": "ThreeDSecureDataV1",
  "eci": "AUTHENTICATION_NOT_ATTEMPTED_OR_UNSUCCESSFUL_00",
  "transactionStatus": "Y",
  "transactionId": "string"
}

TransactionLabel

A label assigned to a transaction by the entity processing the transaction. Labels are used for grouping or discovering transactions after transaction processing. Note that no transaction processing decision is made based on transaction labels.

namestring^[a-zA-Z0-9_]{1,100}$required

Label name that indicates the type and intended use of the transaction label. The meaning of label names must be agreed upon by the parties involved in transaction processing.

valuestring^[a-zA-Z.-9 _-]{1,100}$required

The value assigned to the transaction label.

{
  "name": "string",
  "value": "string"
}

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