URL
Electrum Support
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/
An extension of BaseMessage 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
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
Specifies the details of the underlying transaction being cancelled
Designates which scheme a resolution of investigation is associated with and describes scheme-specific information.
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.{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "originalMessageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "assignment": { "assignee": { … }, "assigner": { … }, "creationDateTime": "2019-08-24T14:15:22Z", "identification": "string" }, "cancellationDetails": { "cancellationStatusReasonInfo": { … }, "originalTransaction": { … }, "originalTransactionIdentifiers": { … }, "transactionCancellationStatus": "RJCR" }, "correctionTransaction": { "messageIdentifiers": { … }, "schema": "CORRECTIVE_INTERBANK_TRANSACTION", "settlementAmount": { … }, "settlementDate": "2019-08-24", "transactionIdentification": { … } }, "paymentScheme": { "schema": "ZA_RTC" }, "resolvedCase": { "creator": { … }, "identification": "string", "reopenCaseIndication": true }, "schema": "ResolutionOfInvestigation", "status": { "confirmationCode": "ACDA", "statusType": "CONFIRMATION" } }
A request containing information that will be used to check if the specified account is eligible to proceed with a payment.
An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.
This may be used by the following schemes:
Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.
Whether the related payment is a CreditTransfer or a DirectDebit.
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.{ "accountIdentifier": { "schema": "string", "value": "string" }, "paymentMethod": "CreditTransfer", "paymentPurpose": { "schema": "string", "value": "BKDF" }, "paymentSchemeName": "ZA_RTC", "supplementaryData": { "property1": "string", "property2": "string" } }