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/
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.PARTIALLY_ACCEPTED: Some, but not all, of the transactions in the group were accepted.{ "outcome": "APPROVED", "reasonInfo": [ { … } ] }
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.PARTIALLY_ACCEPTED: Some, but not all, of the transactions in the group were accepted.{ "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": [ … ] } }
Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Unique identification to unambiguously identify the mandate. This links the direct debit collection to the original mandate.
For DebiCheck, this field contains the scheme-assigned Mandate Reference Number which is the authoritative identifier for linking collections to mandates.
{ "mandateIdentification": "string", "trackingDays": 99 }