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

Languages
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

ClearingSystemMemberIdentification

clearingSystemobject(ClearingSystemIdentification)
memberIdstring<= 35 charactersrequired

Identification of a member of a clearing system.

{
  "clearingSystem": {
    "schema": "string",
    "value": "MA"
  },
  "memberId": "string"
}

InstitutionIdentification

additionalIdentificationsArray of objects(AccountIdentification)
addressobject(PostalAddress)
bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

branchobject(BranchIdentification)
clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
leistring[A-Z0-9]{18,18}[0-9]{2,2}

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

namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

{
  "additionalIdentifications": [
    { … }
  ],
  "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"
  },
  "bicfi": "string",
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "clearingSystemMemberId": {
    "clearingSystem": { … },
    "memberId": "string"
  },
  "companyRegistration": "string",
  "lei": "string",
  "memberId": "string",
  "name": "string"
}

BankingIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

Discriminator
schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

valuestring[ 1 .. 40 ] charactersrequired
{
  "issuer": "string",
  "schema": "GENERIC",
  "scheme": {
    "schema": "string",
    "value": "AIIN"
  },
  "value": "string"
}
Copyright 2025 | Electrum Payments (Pty) Ltd