Electrum Regulated Payments Events API (17.1.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

Download OpenAPI description

elpapi-events.json

elpapi-events.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-events/

Payments API sandbox

https://example.com/path/payments/events-api/v1/

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

Operations

Schema

AccountType

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestring(ExternalCashAccountType1Code)required

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

{
  "schema": "CODE",
  "value": "CACC"
}

Account

An account within the Electrum Account mirror. Note that the primaryIdentification is permanent and immutable.

accountNamestring<= 40 characters

additionalIdentificationsArray of objects(AccountIdentification)

currencystring(CurrencyCode)^[A-Z]{3}$

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

openingDatestring(date-time)

Date and time at which the account was established.

primaryIdentificationobject(AccountIdentification)required

Holds details pertaining to an identifier of an account or store of value.

primaryIdentification.accountKnownAsstring<= 40 characters

A name or label of the account.

primaryIdentification.identifierobject(AccountIdentifier)required

primaryIdentification.identifier.namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

ZA_RPP

primaryIdentification.identifier.schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

primaryIdentification.identifier.valuestring[ 1 .. 2048 ] charactersrequired

primaryIdentification.registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

Items Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

restrictionsArray of objects(Restriction)

statusstring(AccountStatusCode)

A set of codes that describe the status of an account

Enum"ENABLED""DISABLED""DELETED"

typeobject(AccountType)

{
  "accountName": "string",
  "additionalIdentifications": [
    { … }
  ],
  "currency": "string",
  "openingDate": "2019-08-24T14:15:22Z",
  "primaryIdentification": {
    "accountKnownAs": "string",
    "identifier": { … },
    "registeredSchemes": [ … ]
  },
  "restrictions": [
    { … }
  ],
  "status": "ENABLED",
  "type": {
    "schema": "string",
    "value": "CACC"
  }
}

AccountOwner

Contains information detailing the owner of an account, which can be either a person or organisation.

recordIdentifierstring[ 1 .. 50 ] charactersrequired

A unique identifier used to identify this Account Owner record. This is distinct from the identification of the Account Owner, which may or may not be unique within this system, but which is typically used for identification outside of the system, such as passport numbers or national identification numbers. This identifier is used exclusively to identify the owner within this system.

schemastringrequired

Defines the type of owner.

Enum"ORGANISATION""INDIVIDUAL"

Discriminator

addressobject(PostalAddress)

contactDetailsobject(ContactDetails)

countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

identifiersArray of objects(PersonIdentifier)

nameobject(PersonName)

Name of the person.

{
  "recordIdentifier": "string",
  "schema": "INDIVIDUAL",
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "room": "string",
    "streetName": "string",
    "subDepartment": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "contactDetails": {
    "emailAddress": "user@example.com",
    "mobileNumber": "string",
    "phoneNumber": "string"
  },
  "countryOfResidence": "string",
  "identifiers": [
    { … }
  ],
  "name": {
    "additionalNames": "string",
    "firstName": "string",
    "initials": "string",
    "knownAs": "string",
    "lastName": "string",
    "title": "string"
  }
}