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.
RJCR RejectedCancellationRequest - Cancellation request is rejected ACCR AcceptedCancellationRequest - Cancellation is accepted. PDCR PendingCancellationRequest - Cancellation request is pending.
RJCR RejectedCancellationRequest - Cancellation request is rejected ACCR AcceptedCancellationRequest - Cancellation is accepted. PDCR PendingCancellationRequest - Cancellation request is pending.
"RJCR"
Specifies the details of the underlying transaction being cancelled
Contains key elements related to the original transaction that is being referred to.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
{ "cancellationStatusReasonInfo": { "originator": { … }, "reason": { … } }, "originalTransaction": { "amounts": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { … }, "purpose": { … }, "remittanceInformation": { … }, "settlementDate": "2019-08-24", "supplementaryData": { … }, "creditor": { … }, "debtor": { … }, "mandateInformation": { … } }, "originalTransactionIdentifiers": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" }, "transactionCancellationStatus": "RJCR" }
Provides the details of a corrective interbank payment transaction
Holds a point-to-point unique message identification string as well as a message's creation date time.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "schema": "CORRECTIVE_INTERBANK_TRANSACTION", "settlementAmount": { "currency": "string", "value": 0.1 }, "settlementDate": "2019-08-24", "transactionIdentification": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" } }