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/
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
{ "additionalInformation": [ "string" ], "originator": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "string", "identification": { … }, "knownAsName": "string", "legalName": "string" }, "reason": { "schema": "string", "value": "AC02" } }
Contains key elements related to the original transaction that is being referred to.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
CreditTransfer - Transfer of an amount of money in the books of the account servicer.DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
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).
{ "amounts": { "bankSettlementAmount": { … }, "instructedAmount": { … } }, "creditorAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "creditorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "creditorAgentAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "debtorAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "debtorAgent": { "additionalIdentifications": [ … ], "address": { … }, "bicfi": "string", "branch": { … }, "clearingSystemMemberId": { … }, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "debtorAgentAccount": { "currency": "string", "identification": { … }, "name": "string", "proxy": { … }, "type": { … } }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { "categoryPurpose": { … }, "localInstrument": { … }, "serviceLevel": [ … ] }, "purpose": { "schema": "string", "value": "BKDF" }, "remittanceInformation": { "structured": [ … ], "unstructured": [ … ] }, "settlementDate": "2019-08-24", "supplementaryData": { "property1": "string", "property2": "string" }, "creditor": { "party": { … }, "schema": "PARTY" }, "debtor": { "party": { … }, "schema": "PARTY" }, "mandateInformation": { "dateOfSignature": "2019-08-24", "electronicSignature": "string", "finalCollectionDate": "2019-08-24", "firstCollectionDate": "2019-08-24", "frequency": { … }, "mandateIdentification": "string", "reason": { … }, "trackingDays": 1 }, "cancellationId": "string", "cancellationReasonInfo": [ { … } ] }
Sent by a financial institution to request the cancellation of an instruction previously sent.
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.
A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
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.
Designates which scheme a payment cancellation is associated with and describes scheme-specific information for the cancellation.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing scheme.ZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.ZA_AC : South African Authenticated Collections scheme.ZA_RMS: South African Registered Mandate Service scheme.CBPR_PLUS: Cross-Border Payments and Reporting Plus.Identifies the specific business process applicable to the cancellation request.
RECALL: A request to revoke a payment instruction that has not yet settled or is currently in tracking. If successful, the instruction is cancelled without financial movement (no settlement occurs). If the partner makes use of Electrum's collections capabilities, this type is only expected for outbound use.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents the case where a bank has experienced a technical issue that resulted in settled debit collections being processed incorrectly (e.g., a batch of debits was duplicated), and the industry bank is requesting that the partner bank correct the error.
A successful correction means the partner bank initiates a financial Payment Return to recover the funds from the industry bank in order to refund the debtor.
This case is notably different from standard recalls and disputes in that: (1) This strictly requires prior industry/PASA authorisation to invoke, (2) it may be rejected by the partner bank if the correction cannot be applied (e.g., original transaction not found, or the transaction was already reversed via a customer dispute), (3) partial reversals are not permitted, and (4) the bank from industry is limited to exactly 2 (two) retry attempts for the same transaction if an earlier request was rejected.
Contains key elements related to the original transaction that is being referred to.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
CreditTransfer - Transfer of an amount of money in the books of the account servicer.DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.Specifies the underlying reason for the payment transaction
Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
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).
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "assignment": { "assignee": { … }, "assigner": { … }, "creationDateTime": "2019-08-24T14:15:22Z", "identification": "string" }, "case": { "creator": { … }, "identification": "string", "reopenCaseIndication": true }, "originalTransactionIdentifiers": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" }, "paymentScheme": { "schema": "ZA_RTC", "schemeData": { … } }, "schema": "FiToFiPaymentCancellationRequest", "underlyingTransaction": { "amounts": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { … }, "purpose": { … }, "remittanceInformation": { … }, "settlementDate": "2019-08-24", "supplementaryData": { … }, "creditor": { … }, "debtor": { … }, "mandateInformation": { … }, "cancellationId": "string", "cancellationReasonInfo": [ … ] } }