Electrum Regulated Payments Events API (34.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

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

DuplicateCheckStatus

The outcome of a duplicate check.

DUPLICATE: one or more duplicates of the provided transaction were found.
NOT_DUPLICATE: no duplicate of the provided transaction was found.
SKIPPED: the duplicate check was not performed.

string(DuplicateCheckStatus)

The outcome of a duplicate check.

DUPLICATE: one or more duplicates of the provided transaction were found.
NOT_DUPLICATE: no duplicate of the provided transaction was found.
SKIPPED: the duplicate check was not performed.

Enum"DUPLICATE""NOT_DUPLICATE""SKIPPED"

"DUPLICATE"

DuplicateCheckResult

The outcome of the duplicate check. duplicateIdentifiers is only present, and only ever populated, when status is DUPLICATE.

duplicateIdentifiersArray of stringsnon-empty

The identifiers of the transactions that the current transaction is an operational duplicate of. Only present when status is DUPLICATE.

statusstring(DuplicateCheckStatus)required

The outcome of a duplicate check.

DUPLICATE: one or more duplicates of the provided transaction were found.
NOT_DUPLICATE: no duplicate of the provided transaction was found.
SKIPPED: the duplicate check was not performed.

Enum"DUPLICATE""NOT_DUPLICATE""SKIPPED"

{
  "duplicateIdentifiers": [
    "string"
  ],
  "status": "DUPLICATE"
}

DuplicateCheckOutcome

A model to indicate whether or not a transaction is an operational duplicate of a transaction that has already been processed. In the case that the transaction is found to be a duplicate, this model provides the identifiers of the duplicate transactions.

messageIdentifiersobjectrequired

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.

resultobject(DuplicateCheckResult)required

The outcome of the duplicate check. duplicateIdentifiers is only present, and only ever populated, when status is DUPLICATE.

result.duplicateIdentifiersArray of stringsnon-empty

The identifiers of the transactions that the current transaction is an operational duplicate of. Only present when status is DUPLICATE.

result.statusstring(DuplicateCheckStatus)required

The outcome of a duplicate check.

DUPLICATE: one or more duplicates of the provided transaction were found.
NOT_DUPLICATE: no duplicate of the provided transaction was found.
SKIPPED: the duplicate check was not performed.

Enum"DUPLICATE""NOT_DUPLICATE""SKIPPED"

schemastringrequired

Value"DuplicateCheckOutcome"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "result": {
    "duplicateIdentifiers": [ … ],
    "status": "DUPLICATE"
  },
  "schema": "DuplicateCheckOutcome"
}