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://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/
https://example.com/path/payments/partner-api/v1/
RECEIVED: The bulk initiation has been received.PENDING: The bulk initiation is undergoing pre-checks.ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.REJECTED: The bulk initiation has been rejected.{ "outcome": "RECEIVED", "reasonInfo": [ { … } ] }
This message is used to report information about the positive or negative status of an individual credit transfer/direct debit instruction submitted within a bulk initiation, or to report on a pending instruction.
The field originalTransactionData is not mandatory, but will always be populated in payment status reports sent by Electrum.
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.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.
{ "originalTransactionData": { "amounts": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { … }, "remittanceInformation": { … }, "settlementDate": "2019-08-24", "supplementaryData": { … }, "creditor": { … }, "debtor": { … } }, "paymentScheme": { "originalSchemeData": { … }, "schema": "ZA_RTC", "schemeData": { … } }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "transactionIdentifiers": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" } }
A detailed breakdown of the number of transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
{ "numberOfApprovedTransactions": 0, "numberOfCancelledTransactions": 0, "numberOfPendingTransactions": 0, "numberOfRejectedTransactions": 0 }