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

IdentifierSchemeRegistrationResponse

Holds details of the outcome of the registration of an identifier externally with a scheme.

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.

originalMessageIdentifiersobject(MessageIdentifiers)required

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

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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

schemastringrequired

Value"IdentifierSchemeRegistrationResponse"

schemeRegistrationOutcomeobject(SchemeRegistrationOutcome)required

schemeRegistrationOutcome.registrationStatusstringrequired

Enum"ACCEPTED""REJECTED"

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

schemeRegistrationOutcome.agentobject(InstitutionIdentification)required

schemeRegistrationOutcome.agent.additionalIdentificationsArray of objects(AccountIdentification)

schemeRegistrationOutcome.agent.addressobject(PostalAddress)

schemeRegistrationOutcome.agent.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)

schemeRegistrationOutcome.agent.branchobject(BranchIdentification)

schemeRegistrationOutcome.agent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

schemeRegistrationOutcome.agent.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).

schemeRegistrationOutcome.agent.namestring<= 140 characters

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

schemeRegistrationOutcome.agent.companyRegistrationstring<= 35 charactersDeprecated

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

schemeRegistrationOutcome.agent.memberIdstring<= 35 charactersDeprecated

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

schemeRegistrationOutcome.proxyobject(NonBankingIdentifier)required

schemeRegistrationOutcome.proxy.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

schemeRegistrationOutcome.proxy.schemastringrequired

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

Discriminator

schemeRegistrationOutcome.proxy.valuestring[ 1 .. 2048 ] charactersrequired

schemeRegistrationOutcome.reasonCodestring

AB06 : Timeout
AB07 : OfflineAgent
AB10 : ErrorInstructedAgent
AG03 : TransactionNotSupported
AG10 : AgentSuspended
AM18 : InvalidNumberOfTransactions
CH21 : RequiredCompulsoryElementMissing
DT02 : InvalidCreationDate
DUPL : DuplicateRequest
FF02 : SyntaxError
NAUT : NotAuthorised
PD01 : ProxyDomainInvalid
PX02 : InvalidProxy
PX03 : ProxyNotFound
PX04 : ProxyFormatInvalid
PX05 : Restricted Proxy
PX06 : Default proxy already exists
RC02 : InvalidBankIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RR10 : InvalidCharacterSet
RR12 : InvalidPartyID

Enum"AB06""AB07""AB10""AG03""AG10""AM18""CH21""DT02""DUPL""FF02"

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.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "schema": "IdentifierSchemeRegistrationResponse",
  "schemeRegistrationOutcome": {
    "registrationStatus": "ACCEPTED",
    "schema": "ZA_RTC"
  },
  "uetr": "string"
}

PaymentMethod

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

string(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

"CreditTransfer"

BaseOriginalTransactionData

amountsobject(TransactionAmounts)

creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)

paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

paymentTypeInformationobject(PaymentTypeInformation)

remittanceInformationobject(RemittanceInformation)

settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

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

{
  "amounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "paymentMethod": "CreditTransfer",
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "remittanceInformation": {
    "structured": [ … ],
    "unstructured": [ … ]
  },
  "settlementDate": "2019-08-24",
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  }
}