Electrum Regulated Payments Partner API (34.1.0)

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:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

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.

Download OpenAPI description

elpapi-partner-redoc.json

elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

payment-cancellation

Operations related to the cancellation of prior payment instructions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

account-management

Operations that involve customer account information.

Operations

sanctions-assessment

Operations related to the processing of sanctions assessment for payment transactions.

Operations

mandate-management

Operations related to the lifecycle management of direct debit mandates.

Operations

Schema

UnderlyingCopyDetails

Contains the details of the mandate copy request including the original mandate reference.

mandateStatusobject(MandateStatus)

Current status of a mandate.

originalMandateobject(OriginalMandateReference)required

Reference to an original mandate. The mandate may be identified either by a reference (originalMandateIdentification) or by the full details of the mandate as it currently stands (originalMandate). At least one of the two must be provided.

Which of the two is expected depends on who hosts the mandate register:

Electrum hosts the mandate register: originalMandateIdentification on its own is sufficient for mandate amendment, cancellation and suspension requests. Electrum identifies the mandate from the reference and enriches the request with the full mandate details the scheme requires before forwarding it. Partners are not required to perform a mandate information request first in order to construct these requests, although they may still do so if they need to see the current state of the mandate.
The partner hosts the mandate register: the partner is the source of truth for mandate state, so the full originalMandate must be provided.

originalMandate.originalMandateobject(Mandate)

Core mandate data structure containing all the details of a direct debit mandate.

originalMandate.originalMandateIdentificationstring<= 35 characters

Unique identification to unambiguously identify the original mandate. Can be the mandateIdentification as assigned by the creditor or the mandate reference number as assigned by the debtor agent

originalMessageInformationobject(OriginalMandateMessageInformation)

Identifies the original mandate-management message being referenced or responded to. For MandateInformationRequest, this block is optional on the partner request — Electrum will populate it from the latest message recorded against the mandate before forwarding to the scheme.

{
  "mandateStatus": {
    "schema": "string",
    "value": "ACTV"
  },
  "originalMandate": {
    "originalMandate": { … },
    "originalMandateIdentification": "string"
  },
  "originalMessageInformation": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string",
    "messageNameIdentification": "string"
  }
}

MandateInformationRequest

A request for a copy of mandate details. Sent to request the current state of a mandate.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

initiatingPartyobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

paymentSchemeobject(MandatePaymentScheme)required

Designates which scheme a mandate operation is associated with and describes scheme-specific information for the mandate operation where relevant.

paymentScheme.schemastring(PaymentSchemeName)required

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.
TCIB: Transactions Cleared on an Immediate Basis scheme.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS""TCIB"

Discriminator

paymentScheme.schemeDataobject(ZaAcMandatePaymentSchemeData)required

South Africa specific supplementary data fields. These fields supplement the core mandate structure with local requirements.

paymentScheme.schemeData.amendmentTypestring

Identifies the type of mandate amendment being requested. This is required for every MandateAmendmentRequest, and is echoed on the acceptance report for that request. It is not applicable to any other mandate operation and should be omitted from those.

Cession and assignment is carried by the same amendment operation as a routine amendment, but it is an operationally a different workflow, so it is stated explicitly here rather than being inferred from the local instrument code.

CONTRACT_AMENDMENT: A routine (business as usual) amendment to the terms of an existing mandate.
CESSION_AND_ASSIGNMENT: The transfer of a mandate, or a book of mandates, to a different creditor, sponsoring bank or ultimate creditor. Only administrative and creditor fields may be changed - the core contract and payment terms cannot be modified during a cession. Cession and assignment additionally requires prior approval.

Enum"CONTRACT_AMENDMENT""CESSION_AND_ASSIGNMENT"

paymentScheme.schemeData.authenticationTypestringrequired

Indicates the delivery and authentication mechanism of the mandate transaction.

In the ZA_AC scheme, this field dictates the specific Transaction Type (TT) processing rules that will be applied:

REAL_TIME: Maps to TT1 (non-card). The mandate request is routed over the real-time interbank switch without an upfront authentication key. Note: The actual Payer authorisation might be immediate (e.g., 120-second USSD timeout) or delayed (until the end of the day), but the routing type remains REAL_TIME.
PREAUTH: Maps to TT3 (Card Present). Indicates the Payer has already been authenticated via a prior card-and-PIN transaction at the point of interaction. Mandates using this type must include the resulting Message Authentication Code (MAC) in the request payload.
BATCH: Maps to TT2. The mandate request is submitted via delayed bulk file processing.
NOT_APPLICABLE: Debtor authentication is not required for this action (e.g. MandateInformationRequest).

Enum"REAL_TIME""PREAUTH""BATCH""NOT_APPLICABLE"

paymentScheme.schemeData.debtorBankMandateReferencestring<= 22 characters^[0-9]{4}20[0-9]{2}[0-1][0-9][0-3][0-9].{10}$...

The Mandate Reference Number (MRN) assigned by the debtor bank upon mandate acceptance. This is the official, unique industry-wide identification number for the mandate that is unique for the mandate's entire lifecycle (including time in archives).

It is returned in the acceptance report and must be included in subsequent mandate amendment, and suspension requests.

Not to be confused with mandateIdentification (the creditor's internal ID) or mandateRequestTransactionIdentifier (MRTI).

Structure (22 characters):

Bank Number (4 numeric): The 4-digit identifier of the Debtor Bank.
Mandate Creation Date (8 numeric): The date the mandate was successfully registered, formatted strictly as YYYYMMDD.
Free Format (10 alphanumeric): A unique identifier or sequence generated by the Debtor Bank.

paymentScheme.schemeData.mandateRequestTransactionIdentifierstring(MandateRequestTransactionIdentifier)<= 35 characters^\d{4}\d{4}-\d{2}-\d{2}\d{9}$

Mandate Request Transaction Identifier (MRTI) A unique transaction identifier used for matching multiple messages to a single transaction. This identifier is created for each new mandate request to uniquely identify the transaction within the Authenticated Collections scheme.

Important: Usage of mandateRequestTransactionIdentifier**.

If the client is the host of the mandate register and is the source of truth for mandate state the client is required to always populate the MRTI. The format is validated and the provided MRTI is used by Electrum.
If Electrum is the source of truth for mandate state the MRTI should not be provided by the client when initiating new mandate transactions; Electrum will generate a compliant MRTI automatically which will be echoed back to the client.

Structure (23 characters):

Positions 1–4 (4 numeric): Originating bank number. Must be a valid, registered bank.
Positions 5–14 (10 alphanumeric): Origination date in the format YYYY-MM-DD. Must be a valid date.
Positions 15–23 (9 numeric): Mandate sequence number. Unique within the bank and date.

Lifecycle behaviour:

Mandate Initiation Request: The originating bank creates a new, unique MRTI for the initiation request. If not provided by the client, Electrum generates one automatically.
Mandate Amendment Request: A new, unique MRTI is required for the amendment request. If not provided by the client, Electrum generates one automatically. The amendment is linked back to the original mandate using the Mandate Reference Number (MRN).
Mandate Cancellation Request:
- In-flight cancellation: If cancelling a mandate request that is still in-flight (e.g. awaiting debtor authentication), the MRTI must exactly match the MRTI of the in-flight request being cancelled. If not provided, Electrum handles this automatically by retrieving the MRTI of the in-flight transaction.
- Active mandate cancellation: If the mandate is already fully registered and active, a new, unique MRTI must be issued for the cancellation request. If not provided, Electrum determines the mandate state and applies the correct rule automatically.
Mandate Acceptance Report: The response echoes back the MRTI from the request being responded to. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.
Mandate Status Report: The status report echoes back the MRTI from the request being reported on. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.

Validation rules enforced by the scheme:

Must not be blank or spaces.
The bank number (positions 1–4) must be a valid, registered bank.
The date (positions 5–14) must be a valid calendar date.
Must conform to the 23-character structured format.
Must be unique at the time of request origination.

paymentScheme.schemeData.requestTransmissionNumberinteger(MandatePaymentSchemeRequestTransmissionNumber)[ 1 .. 4 ]

Sequence number for the message's transmission. Used exclusively for real-time (TT1/TT3) messages to track message retries. 1 = original message transmission, 2-4 = retries.

schemastringrequired

Value"MandateInformationRequest"

underlyingCopyDetailsobject(UnderlyingCopyDetails)required

Contains the details of the mandate copy request including the original mandate reference.

underlyingCopyDetails.mandateStatusobject(MandateStatus)

Current status of a mandate.

underlyingCopyDetails.originalMandateobject(OriginalMandateReference)required

Which of the two is expected depends on who hosts the mandate register:

Electrum hosts the mandate register: originalMandateIdentification on its own is sufficient for mandate amendment, cancellation and suspension requests. Electrum identifies the mandate from the reference and enriches the request with the full mandate details the scheme requires before forwarding it. Partners are not required to perform a mandate information request first in order to construct these requests, although they may still do so if they need to see the current state of the mandate.
The partner hosts the mandate register: the partner is the source of truth for mandate state, so the full originalMandate must be provided.

underlyingCopyDetails.originalMandate.originalMandateobject(Mandate)

Core mandate data structure containing all the details of a direct debit mandate.

underlyingCopyDetails.originalMandate.originalMandateIdentificationstring<= 35 characters

Unique identification to unambiguously identify the original mandate. Can be the mandateIdentification as assigned by the creditor or the mandate reference number as assigned by the debtor agent

underlyingCopyDetails.originalMessageInformationobject(OriginalMandateMessageInformation)

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "initiatingParty": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "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"
  },
  "paymentScheme": {
    "schema": "ZA_RTC",
    "schemeData": { … }
  },
  "schema": "MandateInformationRequest",
  "underlyingCopyDetails": {
    "mandateStatus": { … },
    "originalMandate": { … },
    "originalMessageInformation": { … }
  }
}

ZaAcCustomerPaymentStatusReportPaymentSchemeData

The mandateRequestTransactionIdentifier and suspensionRequestIdentification are mutually exclusive fields

If the status report is responding to a standard mandate operation (Initiation, Amendment, Cancellation), it echoes the MRTI.
If the status report is responding to a Suspension, it echoes the Suspension Request Identification.

mandateRequestTransactionIdentifierstring(MandateRequestTransactionIdentifier)<= 35 characters^\d{4}\d{4}-\d{2}-\d{2}\d{9}$

Important: Usage of mandateRequestTransactionIdentifier**.

If the client is the host of the mandate register and is the source of truth for mandate state the client is required to always populate the MRTI. The format is validated and the provided MRTI is used by Electrum.
If Electrum is the source of truth for mandate state the MRTI should not be provided by the client when initiating new mandate transactions; Electrum will generate a compliant MRTI automatically which will be echoed back to the client.

Structure (23 characters):

Positions 1–4 (4 numeric): Originating bank number. Must be a valid, registered bank.
Positions 5–14 (10 alphanumeric): Origination date in the format YYYY-MM-DD. Must be a valid date.
Positions 15–23 (9 numeric): Mandate sequence number. Unique within the bank and date.

Lifecycle behaviour:

Mandate Initiation Request: The originating bank creates a new, unique MRTI for the initiation request. If not provided by the client, Electrum generates one automatically.
Mandate Amendment Request: A new, unique MRTI is required for the amendment request. If not provided by the client, Electrum generates one automatically. The amendment is linked back to the original mandate using the Mandate Reference Number (MRN).
Mandate Cancellation Request:
- In-flight cancellation: If cancelling a mandate request that is still in-flight (e.g. awaiting debtor authentication), the MRTI must exactly match the MRTI of the in-flight request being cancelled. If not provided, Electrum handles this automatically by retrieving the MRTI of the in-flight transaction.
- Active mandate cancellation: If the mandate is already fully registered and active, a new, unique MRTI must be issued for the cancellation request. If not provided, Electrum determines the mandate state and applies the correct rule automatically.
Mandate Acceptance Report: The response echoes back the MRTI from the request being responded to. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.
Mandate Status Report: The status report echoes back the MRTI from the request being reported on. For API-level correlation, clients use originalMessageIdentifiers.messageIdentification instead.

Validation rules enforced by the scheme:

Must not be blank or spaces.
The bank number (positions 1–4) must be a valid, registered bank.
The date (positions 5–14) must be a valid calendar date.
Must conform to the 23-character structured format.
Must be unique at the time of request origination.

requestTransmissionNumberinteger(MandatePaymentSchemeRequestTransmissionNumber)[ 1 .. 4 ]

Sequence number for the message's transmission. Used exclusively for real-time (TT1/TT3) messages to track message retries. 1 = original message transmission, 2-4 = retries.

suspensionRequestIdentificationstring(MandateSuspensionRequestIdentification)<= 35 characters^STP/\d{4}/20\d{2}-\d{2}-\d{2}/\d{9}$

Suspension Request Identification A unique transaction identifier used to unambiguously identify the mandate suspension request to the clearing house.

Important: Usage of suspensionRequestIdentification**.

If the client is the host of the mandate register and is the source of truth for mandate state the client is required to always populate the suspensionRequestIdentification in the MandateSuspensionRequest. The format is validated and the provided suspensionRequestIdentification is used by Electrum.
If Electrum is the source of truth for mandate state the suspensionRequestIdentification should not be provided by the client when initiating new mandate suspension; Electrum will generate a compliant suspensionRequestIdentification automatically which will be echoed back to the client.

Lifecycle behaviour:

Mandate Suspension Request: The originating bank creates a new, unique suspensionRequestIdentification for the suspension request. If not provided by the client, Electrum generates one automatically.
Customer Payment Status Report: The suspensionRequestIdentification is echoed in CustomerPaymentStatusReports that confirm the outcome of a mandate suspension.

Structure (29 characters): The identifier is composed of 4 components separated by forward slashes (/), matching the pattern STP/<BankCode>/<Date>/<Sequence>:

Prefix (STP): Fixed string indicating a Suspension.
Bank Code (4 numeric): The 4-digit identifier of the initiating bank.
Date (10 alphanumeric): The date the suspension is generated in YYYY-MM-DD format.
Sequence Number (9 numeric): Mandate Suspension sequence number. Must be unique within the bank and date.

{
  "mandateRequestTransactionIdentifier": "string",
  "requestTransmissionNumber": 1,
  "suspensionRequestIdentification": "string"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations