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.
Provides details about whether and how a debit may be disputed by the debtor. This model encapsulates dispute eligibility metadata which can be passed through pacs.003 payloads to downstream systems.
Reason codes indicating why the debit may or may not be disputed by the debtor.
{ "disputable": true, "disputableReasons": [ { … } ], "disputePeriodDays": 0 }
Base model for payment transaction frequencies expressed in terms of days of the month. Not expected to be used directly; see MonthlyFrequency, QuarterlyFrequency, BiannualFrequency and YearlyFrequency.
Specifies the day of the month on which the payment transaction is to be processed. NOTE: A value of 31 will be interpreted as the last day of the month.
{ "dayOfMonth": 1, "schema": "BiannualFrequency" }
Base model for payment transaction frequencies expressed in terms of days of the month. Not expected to be used directly; see MonthlyFrequency, QuarterlyFrequency, BiannualFrequency and YearlyFrequency.
Specifies the day of the month on which the payment transaction is to be processed. NOTE: A value of 31 will be interpreted as the last day of the month.
{ "dayOfMonth": 1, "schema": "BiannualFrequency" }