Merchant

URL

https://electrum.co.za/contact

Electrum Support

support@electrum.co.za

License

Apache 2.0

LoyaltyCardPayment

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

Merchant

Merchant related data. Must be included if available

merchantTypestring[0-9]{4}required

The assigned four digit merchant category code

merchantIdstring= 15 charactersrequired

The assigned merchant identifier. Also known as card acceptor id

merchantNameobject(MerchantName)required

A container object representing the Merchant Name and Location

merchantName.namestring[ 0 .. 23 ] charactersrequired

The merchant or trading as name associated with the merchant

merchantName.citystring[ 0 .. 13 ] charactersrequired

The city where the merchant is located

merchantName.regionstring[ 0 .. 2 ] charactersrequired

The state or region where the merchant is located

merchantName.countrystring[ 0 .. 2 ] charactersrequired

The country where the merchant is located

{
  "merchantType": "string",
  "merchantId": "stringstringstr",
  "merchantName": {
    "name": "string",
    "city": "string",
    "region": "st",
    "country": "st"
  }
}

MerchantName

A container object representing the Merchant Name and Location

namestring[ 0 .. 23 ] charactersrequired

The merchant or trading as name associated with the merchant

citystring[ 0 .. 13 ] charactersrequired

The city where the merchant is located

regionstring[ 0 .. 2 ] charactersrequired

The state or region where the merchant is located

countrystring[ 0 .. 2 ] charactersrequired

The country where the merchant is located

{
  "name": "string",
  "city": "string",
  "region": "st",
  "country": "st"
}

Lotto Service Interface (2.0.0)

Lotto Game Rules Service Interface

Lotto Games Service Interface

Lotto Wager Service Interface

Schema

LoyaltyCardPayment

Merchant

MerchantName