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.
https://example.com/path/payments/events-api/v1/
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.
Represents the result of checking a validation step during a validation operation. Note that the reasonInfo value will typically be set in the case that the result is FAILED, whereas it may or may not be set if the result is PASSED or NOT_RUN. It is also expected that the reason used in reasonInfo values is always of type CODE and not PROPRIETARY.
{ "description": "string", "reasonInfo": { "additionalInformation": "string", "reason": { … } }, "result": "PASSED" }
An overall indication of whether the validation operation was successful. True if none of the validation steps failed (i.e. have result FAILED); false otherwise.
A list of results for each validation step checked as part of the validation operation.
{ "isSuccessful": true, "schema": "ValidationOutcome", "steps": [ { … } ] }
Holds a point-to-point unique message identification string as well as a message's creation 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
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds details pertaining to an identifier of an account or store of value.
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:
Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.
Holds details pertaining to an identifier of an account or store of value.
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:
Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.
{ "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" }