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

AccountUpdateRequest

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

accountobject(Account)required

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

account.accountNamestring<= 40 characters

account.additionalIdentificationsArray of objects(AccountIdentification)

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

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

account.openingDatestring(date-time)

Date and time at which the account was established.

account.primaryIdentificationobject(AccountIdentification)required

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

account.primaryIdentification.accountKnownAsstring<= 40 characters

A name or label of the account.

account.primaryIdentification.identifierobject(AccountIdentifier)required

account.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

account.primaryIdentification.identifier.schemastringrequired

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

Discriminator

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

account.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"

account.restrictionsArray of objects(Restriction)

account.statusstring(AccountStatusCode)

A set of codes that describe the status of an account

Enum"ENABLED""DISABLED""DELETED"

account.typeobject(AccountType)

otherAccountOwnerDetailsArray of objects(AccountOwner)

primaryAccountOwnerDetailsobject(AccountOwner)required

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

primaryAccountOwnerDetails.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.

primaryAccountOwnerDetails.schemastringrequired

Defines the type of owner.

Enum"ORGANISATION""INDIVIDUAL"

Discriminator

primaryAccountOwnerDetails.addressobject(PostalAddress)

primaryAccountOwnerDetails.contactDetailsobject(ContactDetails)

primaryAccountOwnerDetails.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).

primaryAccountOwnerDetails.identifiersArray of objects(PersonIdentifier)

primaryAccountOwnerDetails.nameobject(PersonName)

Name of the person.

schemastringrequired

Value"AccountUpdateRequest"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "account": {
    "accountName": "string",
    "additionalIdentifications": [ … ],
    "currency": "string",
    "openingDate": "2019-08-24T14:15:22Z",
    "primaryIdentification": { … },
    "restrictions": [ … ],
    "status": "ENABLED",
    "type": { … }
  },
  "otherAccountOwnerDetails": [
    { … }
  ],
  "primaryAccountOwnerDetails": {
    "recordIdentifier": "string",
    "schema": "ORGANISATION"
  },
  "schema": "AccountUpdateRequest"
}

TransactionIdentifiers

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

uetrstring(UUID)required

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

{
  "endToEndIdentification": "string",
  "instructionIdentification": "string",
  "transactionIdentification": "string",
  "uetr": "string"
}

BaseTransactionMessage

A model containing the foundational elements shared across messages relating to transactions.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

transactionIdentifiers.instructionIdentificationstring<= 35 characters

transactionIdentifiers.transactionIdentificationstring<= 35 characters

transactionIdentifiers.uetrstring(UUID)required

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

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}