The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.
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. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.
https://example.com/path/payments/api/v1/
An extension of BaseTransactionMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
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.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Provides details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
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.
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "originalMessageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "transactionIdentifiers": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" }, "instructedAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "instructingAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "mandateInformation": { "dateOfSignature": "2019-08-24", "electronicSignature": "string", "finalCollectionDate": "2019-08-24", "firstCollectionDate": "2019-08-24", "frequency": { … }, "mandateIdentification": "string", "reason": { … }, "trackingDays": 1 }, "originalTransactionData": { "amounts": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { … }, "purpose": { … }, "remittanceInformation": { … }, "settlementDate": "2019-08-24", "supplementaryData": { … }, "creditor": { … }, "debtor": { … }, "initiatingParty": { … } }, "paymentScheme": { "originalSchemeData": { … }, "schema": "ZA_RTC", "schemeData": { … } }, "schema": "PaymentStatusReport" }
AC04 ClosedAccountNumber - Account number specified has been closed on the receiver’s books. ADAC AwaitingDebitAuthorityFromCustomer - Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account. AGNT AgentDecision - Reported when the cancellation cannot be accepted because of an agent refuses to cancel. AM04 InsufficientFunds - Amount of funds available to cover specified message amount is insufficient. ARDT AlreadyReturned - Cancellation not accepted as the transaction has already been returned. ARPL AwaitinReply - Reported when the cancellation request cannot be processed because no reply has been received yet from the receiver of the request message. CUST CustomerDecision - Reported when the cancellation cannot be accepted because of a customer decision (Creditor). LEGL LegalDecision - Reported when the cancellation cannot be accepted because of regulatory rules. NARR Narrative - Reason is provided as narrative information in the additional reason information. NOAS NoAnswerFromCustomer - No response from beneficiary (to the cancellation request). NOOR NoOriginalTransactionReceived - Original transaction (subject to cancellation) never received. PTNA PassedToTheNextAgent - Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent. RQDA RequestingDebitAuthority - Reported when authority is required by the Creditor to return the payment. WSEQ WrongSequence - Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid. INDM CancellationIndemnityRequired - Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established. ACLR AlreadyCancelledRTP - Request-to-pay has already been cancelled. AEXR AlreadyExpiredRTP - Request-to-pay Expiry Date and Time has already passed. ARFR AlreadyRefusedRTP - Request-to-pay has already been refused by the Debtor. ARJR AlreadyRejectedRTP - Request-to-pay has already been rejected. PATE PaymentAlreadyTransmittedExecution - Payment related to the request-to-pay has already been transmitted for execution. RR04 RegulatoryReason - Regulatory Reason. RCAR RfCAlreadyRejected - Request for cancellation of the request-to-pay has already been rejected. RCNR RfCNeverReceived - Request for cancellation of the request-to-pay has never been received. RCPR RfCReceivedAndProcessed - Request for cancellation of the request-to-pay has already been received and processed. URTP UnknownRTP - Request-to-pay is unknown. AACR AlreadyAcceptedRTP - Request-to-pay (RTP) has already been accepted.
{ "schema": "string", "value": "AC04" }