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

InstitutionIdentificationWithSchemaAndDomain

schemastring

Discriminator

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

domainstring<= 35 characters

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier

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.

{
  "schema": "INSTITUTION_IDENTIFICATION",
  "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",
  "domain": "string"
}

PartyWithSchema

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

schemastring

Discriminator

additionalIdentificationsArray of objects(AccountIdentification)

addressobject(PostalAddress)

bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

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

domainstring<= 35 characters

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier

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.

{
  "schema": "INSTITUTION_IDENTIFICATION",
  "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",
  "domain": "string"
}

ZaRppDeterminationRequest

A request providing information for the lookup of a proxy or account in the context of the ZA RPP Payment Scheme:

If the identifier schema is either MOBILE or CUSTOM, proxy resolution will be performed. In this case, the identifier.namespace field is required.
If the identifier schema is GENERIC, account resolution will be performed. In this case, the accountAgent.bicfi field is required.

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

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

Discriminator

accountAgentobject(InstitutionIdentification)

identifierany(ZaRppIdentifier)required

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

identifier.schemastringrequired

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

Discriminator

identifier.valuestring[ 1 .. 2048 ] charactersrequired

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

requestorobject(ZaRppRequestor)

uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference. This identifier remains the same for all messages related to the same transaction.

verificationIdentificationstring[ 1 .. 35 ] charactersrequired

Unique identifier for this specific verification request.

{
  "schema": "ZA_RPP",
  "accountAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "identifier": {
    "namespace": "string",
    "schema": "string",
    "value": "string"
  },
  "instructedAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "instructingAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "requestor": {
    "schema": "string"
  },
  "uetr": "string",
  "verificationIdentification": "string"
}