CurrencyCode

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.

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.

AccountAdditionalIdUpdateRequest

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.

additionalIdentificationobject(AccountIdentification)required

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

additionalIdentification.accountKnownAsstring<= 40 characters

A name or label of the account.

additionalIdentification.identifierobject(AccountIdentifier)required

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

additionalIdentification.identifier.schemastringrequired

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

Discriminator

additionalIdentification.identifier.valuestring[ 1 .. 2048 ] charactersrequired

additionalIdentification.registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

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

currentIdentificationobject(AccountIdentification)required

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

currentIdentification.accountKnownAsstring<= 40 characters

A name or label of the account.

currentIdentification.identifierobject(AccountIdentifier)required

currentIdentification.identifier.namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

currentIdentification.identifier.schemastringrequired

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

Discriminator

currentIdentification.identifier.valuestring[ 1 .. 2048 ] charactersrequired

currentIdentification.registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

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

schemastringrequired

Value"AccountAdditionalIdUpdateRequest"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "additionalIdentification": {
    "accountKnownAs": "string",
    "identifier": { … },
    "registeredSchemes": [ … ]
  },
  "currentIdentification": {
    "accountKnownAs": "string",
    "identifier": { … },
    "registeredSchemes": [ … ]
  },
  "schema": "AccountAdditionalIdUpdateRequest"
}

Restriction

restrictionTypestringrequired

A value that represents the type of this restriction. Used for processing purposes.

Enum"NO_CREDITS""NO_DEBITS"

validFromstring(date-time)required

The moment in time from which (i.e. at this point and after) the restriction is applicable.

validUntilstring(date-time)

The moment in time from which (i.e. after this point) the restriction is no longer applicable.

{
  "restrictionType": "NO_CREDITS",
  "validFrom": "2019-08-24T14:15:22Z",
  "validUntil": "2019-08-24T14:15:22Z"
}

Electrum Regulated Payments Events API (17.1.0)

state

Schema

AccountAdditionalIdUpdateRequest

CurrencyCode

Restriction