OrganisationIdentifierBic

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.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

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.

PersonAccountOwner

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

OrganisationIdentifierBic

An organisation identified by a code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - Banking - Banking telecommunication messages - Business identifier code (BIC).

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

{
  "BIC": "string",
  "schema": "string"
}

OrganisationIdentifierLei

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

LEIstring[A-Z0-9]{18,18}[0-9]{2,2}required

schemastringrequired

Indicates the identifier as a LEI organisation identifier, always LEI

{
  "LEI": "string",
  "schema": "string"
}

Electrum Regulated Payments Events API (17.1.0)

state

Schema

PersonAccountOwner

OrganisationIdentifierBic

OrganisationIdentifierLei