RewardPayment

URL

https://electrum.co.za/contact

Electrum Support

support@electrum.co.za

License

Apache 2.0

QrPayment

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

RewardPayment

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

SlipData

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

messageLinesArray of objects(SlipLine)

An array of text lines and optional formatting to be printed on the customer slip.

slipWidthinteger(int32)

The width of the slip in normal (unformatted) characters.

issuerReferencestring[A-Z0-9]{1,40}

An identifier that is printed on the customer slip and uniquely identifies the payment on the service provider's system. This value is used by the customer to request a refund when the service supports this function, and it is thus important that this number is unique.

{
  "messageLines": [
    { … }
  ],
  "slipWidth": 0,
  "issuerReference": "string"
}

Lotto Service Interface (2.0.0)

Lotto Game Rules Service Interface

Lotto Games Service Interface

Lotto Wager Service Interface

Schema

QrPayment

RewardPayment

SlipData