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://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-events/
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.
Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.
{ "applicability": "CREDIT", "authority": { "country": "string", "name": "string" }, "details": [ { … } ] }
Information necessary for FI to FI customer credit transfers, specifically for CBPR+
DEBT (BorneByDebtor): All transaction charges are to be borne by the debtorCRED (BorneByCreditor): All transaction charges are to be borne by the creditorSHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or schemeFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
{ "chargeBearer": "DEBT", "charges": [ { … } ], "exchangeRate": 0.1, "regulatoryReporting": [ { … } ] }
Information necessary for FI to FI customer credit transfers, specifically for CBPR+
DEBT (BorneByDebtor): All transaction charges are to be borne by the debtorCRED (BorneByCreditor): All transaction charges are to be borne by the creditorSHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or schemeFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
{ "schema": "string", "schemeData": { "chargeBearer": "DEBT", "charges": [ … ], "exchangeRate": 0.1, "regulatoryReporting": [ … ] } }