PaymentMethod

URL

https://electrum.co.za/contact

Electrum Support

support@electrum.co.za

License

Apache 2.0

Originator

The Originator object encapsulates data relating to the originator of the transaction

institutionobject(Institution)required

Originating, acquiring, processing, or receiving institution details

institution.idstringrequired

The institution's ID. API implementations should take care to set this field as appropriate for the implementation.

institution.namestring[ 0 .. 40 ] charactersrequired

The institutions's name

terminalIdstring= 8 charactersrequired

The ID that uniquely identifies each device or system in an originator's institution capable of sending requests. Required for transactions initiated from physical card entry or point-of-sale devices

merchantobject(Merchant)required

Merchant related data. Must be included if available

merchant.merchantTypestring[0-9]{4}required

The assigned four digit merchant category code

merchant.merchantIdstring= 15 charactersrequired

The assigned merchant identifier. Also known as card acceptor id

merchant.merchantNameobject(MerchantName)required

A container object representing the Merchant Name and Location

merchant.merchantName.namestring[ 0 .. 23 ] charactersrequired

The merchant or trading as name associated with the merchant

merchant.merchantName.citystring[ 0 .. 13 ] charactersrequired

The city where the merchant is located

merchant.merchantName.regionstring[ 0 .. 2 ] charactersrequired

The state or region where the merchant is located

merchant.merchantName.countrystring[ 0 .. 2 ] charactersrequired

The country where the merchant is located

operatorIdstring[ 0 .. 30 ] characters

The ID that uniquely identifies the person operating the terminal specified by the terminalId field.

channelIdstring[ 0 .. 50 ] characters

The ID that uniquely identifies the originator's channel that this transaction was received through.

{
  "institution": {
    "id": "string",
    "name": "string"
  },
  "terminalId": "stringst",
  "merchant": {
    "merchantType": "string",
    "merchantId": "stringstringstr",
    "merchantName": { … }
  },
  "operatorId": "string",
  "channelId": "string"
}

PaymentMethod

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

Base model for capturing either a clear PIN or encrypted PIN

typestringrequired

Whether the PIN is communicated in the clear or encrypted.

Enum"CLEAR_PIN""ENCRYPTED_PIN""HASHED_PIN"

Discriminator

pinstring.{0,20}required

A clear PIN

{
  "type": "CLEAR_PIN",
  "pin": "string"
}

Lotto Service Interface (2.0.0)

Lotto Game Rules Service Interface

Lotto Games Service Interface

Lotto Wager Service Interface

Schema

Originator

PaymentMethod

Pin