The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.
This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.
https://example.com/path/payments/partner-api/v1/
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" } }