EventMessageInfo

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

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

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.

EsmStateEvent

An event that indicates a state change of the ESM for a given transaction. An event contains information An event that indicates a state change of the ESM for a given transaction. An event contains information regarding the ESM's view of a given transaction as the state of the transaction changes.

apiVersionstringrequired

The version of the Electrum Regulated Payments Events API which the event format conforms to i.e. the version of this API.

classstringrequired

The class of the event.

Discriminator

bulkInformationIdstring(UUID)required

A UUID to identify the bulk

creationDateTimestring(date-time)required

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

transactionInfoobject(BulkEventTransactionInfo)

{
  "apiVersion": "string",
  "class": "BULK_INDIVIDUAL_TRANSACTION_STATE",
  "bulkInformationId": "string",
  "creationDateTime": "2019-08-24T14:15:22Z",
  "transactionInfo": {
    "rawTransaction": "string",
    "transactionId": "string",
    "transactionState": "string",
    "transactionStateUpdated": "2019-08-24T14:15:22Z",
    "transactionStatusRsp": "string"
  }
}

EventMessageInfo

Message-specific properties of the event. These are populated on a best-effort basis.

creationDateTimestring(date-time)

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

httpStatusCodeinteger

The HTTP status code associated with this message of this event.

messageIdentificationstring<= 35 characters

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.

{
  "creationDateTime": "2019-08-24T14:15:22Z",
  "httpStatusCode": 0,
  "messageIdentification": "string"
}

MessageIdentifiers

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

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

messageIdentificationstring<= 35 charactersrequired

{
  "creationDateTime": "2019-08-24T14:15:22Z",
  "messageIdentification": "string"
}

Electrum Regulated Payments Events API (18.1.0)

state

Schema

EsmStateEvent

EventMessageInfo

MessageIdentifiers