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

ThirdPartyIdentifier

An identifier assigned by an entity which process the message. Identifiers are keyed by institution ID thereby enabling any institution to recall a transaction within the entity's own system using the entity's own identifier. Entities must not alter the identifier set by another entity. Once an identifier has been set by an entity, all other entities must send that identifier in subsequent messages.

institutionIdstringrequired

The entity's institution ID.

transactionIdentifierstringrequired

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

{
  "institutionId": "string",
  "transactionIdentifier": "string"
}

Tender

Details of the Tender used by a customer towards a payment

accountTypestring

The type of account

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

amountobject(LedgerAmount)required

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

amount.amountinteger(int64)required

Amount in minor denomination, e.g. R799.95 is encoded as 79995

amount.currencystring[0-9]{3}required

Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710

amount.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"

cardNumberstring[0-9]{6}[0-9*]{0,13}

A PCI compliant masked card number, with at least the first 6 digits in the clear. Only applicable to card based transactions

referencestring[ 0 .. 40 ] characters

A free text reference

tenderTypestringrequired

The type of tender used

Enum"CASH""CHEQUE""CREDIT_CARD""DEBIT_CARD""WALLET""ROUNDING""GIFT_CARD""LOYALTY_CARD""OTHER""REWARD"

{
  "accountType": "DEFAULT",
  "amount": {
    "amount": 0,
    "currency": "string",
    "ledgerIndicator": "DEBIT"
  },
  "cardNumber": "string",
  "reference": "string",
  "tenderType": "CASH"
}

TenderAdvice

An advice that notifies of the successful completion of a transaction.

idstringrequired

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

requestIdstringrequired

The UUID identifying the request that this advice relates to

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

thirdPartyIdentifiersArray of objects(ThirdPartyIdentifier)required

The unaltered thirdPartyIdentifiers array as supplied in the related BasicResponse message. Required if thirdPartyIdentifiers field was present in the BasicResponse. If no thirdPartyIdentifiers was received in the BasicResponse or no BasicResponse was received then this should be set to the thirdPartyIdentifiers sent in the original request.

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.

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.

tendersArray of objects(Tender)required

An array of tenders used to pay for the transaction

tenders[].accountTypestring

The type of account

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

tenders[].amountobject(LedgerAmount)required

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

tenders[].amount.amountinteger(int64)required

Amount in minor denomination, e.g. R799.95 is encoded as 79995

tenders[].amount.currencystring[0-9]{3}required

Three digit currency number from ISO 4217, e.g. South African Rand is encoded as 710

tenders[].amount.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"

tenders[].cardNumberstring[0-9]{6}[0-9*]{0,13}

A PCI compliant masked card number, with at least the first 6 digits in the clear. Only applicable to card based transactions

tenders[].referencestring[ 0 .. 40 ] characters

A free text reference

tenders[].tenderTypestringrequired

The type of tender used

Enum"CASH""CHEQUE""CREDIT_CARD""DEBIT_CARD""WALLET""ROUNDING""GIFT_CARD""LOYALTY_CARD""OTHER""REWARD"

{
  "id": "string",
  "requestId": "string",
  "time": "2019-08-24T14:15:22Z",
  "thirdPartyIdentifiers": [
    { … }
  ],
  "stan": "string",
  "rrn": "string",
  "amounts": {
    "requestAmount": { … },
    "approvedAmount": { … },
    "feeAmount": { … },
    "balanceAmount": { … },
    "additionalAmounts": { … }
  },
  "tenders": [
    { … }
  ]
}