Electrum Regulated Payments API (26.1.1)

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:

  • Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in this document.
  • 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 the Electrum Regulated Payments Partner API.

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.

Download OpenAPI description
elpapi-redoc.json
elpapi-redoc.yaml
Overview
URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Languages
Servers
Payments API sandbox

https://example.com/path/payments/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

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

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

Operations

refund

Operations related to the refund of a prior successful financial transaction.

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

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

OriginalMandateReference

Reference to an original mandate. The partner may identify the mandate using any of the following identifiers, depending on the context of the request and the information available. At least one of originalMandateIdentification for the original mandate, or originalMandate must be provided.

For mandate amendment, cancellation and suspension requests, originalMandate is required and the originalMandateIdentification cannot be used as the sole reference.

originalMandateobject(Mandate)

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

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

{
  "originalMandate": {
    "adjustment": { … },
    "authentication": { … },
    "collectionAmount": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "creditorSchemeIdentification": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "firstCollectionAmount": { … },
    "mandateIdentification": "string",
    "mandateReference": "string",
    "mandateRequestIdentification": "string",
    "maximumAmount": { … },
    "occurrences": { … },
    "reason": { … },
    "referredDocument": [ … ],
    "trackingIndicator": true,
    "type": { … },
    "ultimateCreditor": { … },
    "ultimateDebtor": { … }
  },
  "originalMandateIdentification": "string"
}

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.

creationDateTimestring(date-time)

The creation date and time of the original message.

messageIdentificationstring<= 35 charactersrequired

The identification of the original message.

messageNameIdentificationstring<= 35 charactersrequired

The name/type of the original message (e.g. MandateInitiationRequest).

{
  "creationDateTime": "2019-08-24T14:15:22Z",
  "messageIdentification": "string",
  "messageNameIdentification": "string"
}

UnderlyingAmendmentDetails

Contains the details of the mandate amendment including the reason, amended mandate, and original mandate reference.

amendedMandateobject(Mandate)required

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

amendedMandate.​adjustmentobject(MandateAdjustmentRules)

Defines adjustment rules for mandate amounts.

amendedMandate.​authenticationobject(MandateAuthentication)

Identifies the specific mechanism or channel that the Paying Bank (Debtor Bank) uses to communicate with the Payer (Debtor) to obtain their authorisation for a mandate. This field may be missing on mandate initiation/amendment and should be populated by the debtor bank upon acceptance of the mandate

amendedMandate.​collectionAmountobject(Amount)
amendedMandate.​creditorobject(Party)required

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

amendedMandate.​creditor.​addressobject(PostalAddress)
amendedMandate.​creditor.​contactDetailsobject(ContactDetails)
amendedMandate.​creditor.​countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

amendedMandate.​creditor.​identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

amendedMandate.​creditor.​knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

amendedMandate.​creditor.​legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

amendedMandate.​creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

amendedMandate.​creditorAgentobject(InstitutionIdentification)
amendedMandate.​creditorSchemeIdentificationobject(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.

amendedMandate.​debtorobject(Party)required

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

amendedMandate.​debtor.​addressobject(PostalAddress)
amendedMandate.​debtor.​contactDetailsobject(ContactDetails)
amendedMandate.​debtor.​countryOfResidencestring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

amendedMandate.​debtor.​identificationobject(PartyIdentification)

The identification of a party, either a person or an organisation.

amendedMandate.​debtor.​knownAsNamestring[ 1 .. 140 ] characters

The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.

amendedMandate.​debtor.​legalNamestring[ 1 .. 140 ] characters

The legal name by which this party is known (the "FICA" name). This is the full name of the party as found on country-issued documentation (national identity, company registration documentation etc).

amendedMandate.​debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

amendedMandate.​debtorAgentobject(InstitutionIdentification)required
amendedMandate.​debtorAgent.​additionalIdentificationsArray of objects(AccountIdentification)
amendedMandate.​debtorAgent.​addressobject(PostalAddress)
amendedMandate.​debtorAgent.​bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

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)

amendedMandate.​debtorAgent.​branchobject(BranchIdentification)
amendedMandate.​debtorAgent.​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
amendedMandate.​debtorAgent.​leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

amendedMandate.​debtorAgent.​namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

amendedMandate.​debtorAgent.​companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

amendedMandate.​debtorAgent.​memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

amendedMandate.​firstCollectionAmountobject(Amount)
amendedMandate.​mandateIdentificationstring<= 35 characters

Unique identification of the mandate, as assigned by the creditor. This field is used strictly by the Creditor for their own internal referencing and may be used to link collections to their related mandate. This is required for mandate initiations and cancellations.

amendedMandate.​mandateReferencestring<= 35 characters

Reference assigned to the mandate by the mandate management application. This is distinct from mandateIdentification (creditor's ID) and ZaMandatePaymentSchemeSupplementaryData.debtorBankMandateReference (debtor bank's reference).

amendedMandate.​mandateRequestIdentificationstring<= 35 characters

Unique identification of the mandate request, as assigned by the creditor to the debtor when the underlying contract is concluded between the two parties. This field represents the Contract Reference Number. It appears on the debtor's bank statement to help them identify the deductions. This is required for mandate initiations and mandate cancellations.

amendedMandate.​maximumAmountobject(Amount)
amendedMandate.​occurrencesobject(MandateOccurrences)

Defines the frequency and duration of mandate collections.

amendedMandate.​reasonobject(MandateReason)

Specifies the reason for a mandate action (amendment, cancellation, rejection).

amendedMandate.​referredDocumentArray of objects(ReferredDocument)

Provides information to identify the underlying documents associated with the mandate

amendedMandate.​trackingIndicatorboolean

Indicates whether the mandate permits tracking for future collection instructions. Its exact meaning and relevance depend strictly on the mandate-management operation being performed:

1. Mandate Initiation & Amendment Requests

  • Required: Specifies whether tracking capabilities are permitted (true) or revoked (false) for future collections against this mandate.

2. Mandate Cancellation Requests

  • Required: Acts specifically as a Tracking Cancellation Indicator to manage collections that are already in-flight.
    • true: Instructs the clearing house to immediately cancel any active tracking records currently in the tracking queue for this mandate.
    • false: Instructs the clearing house NOT to cancel records in tracking, allowing them to finish their tracking cycle despite the mandate being cancelled.

3. Mandate Acceptance Reports

  • Required: Echoes the definitive tracking setting (true or false) that was successfully saved to the Debtor Bank's Mandate Register.

4. Mandate Suspensions & Information Requests

  • Not Applicable: This field is ignored for lookup and suspension operations.
amendedMandate.​typeobject(MandateTypeInformation)

Provides details on the type of mandate.

amendedMandate.​ultimateCreditorobject(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.

amendedMandate.​ultimateDebtorobject(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.

amendmentReasonobject(MandateAmendmentReason)required

Provides details about the reason for a mandate amendment.

Field Usage Guidelines: reason: For South African Mandate Schemes the reason for the amendment is specified as one of the below PROPRIETARY values:

  • MD02 - Reason has not been specified by end consumer.
  • MD16 - Requested by Customer..
  • MD17 - Amendment requested by Initiating Party.
  • MD19 - Unsuspend a Mandate with changes.
  • MD20 - Unsuspend an unchanged Mandate.
  • MD21 - Amendment with no changes to Mandate Information.
  • MD22 - Amendment with changes to Mandate Information.
amendmentReason.​additionalInformationArray of strings
amendmentReason.​originatorobject(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.

amendmentReason.​reasonobject(MandateReason)required

Specifies the reason for a mandate action (amendment, cancellation, rejection).

amendmentReason.​reason.​schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
amendmentReason.​reason.​valuestringrequired
  • AC01 - IncorrectAccountNumber
  • AC04 - ClosedAccountNumber
  • AC06 - BlockedAccount
  • AG01 - TransactionForbidden
  • AG02 - InvalidBankOperationCode
  • AM02 - NotAllowedAmount
  • AM03 - NotAllowedCurrency
  • AM05 - Duplication
  • BE01 - InconsistenWithEndCustomer
  • BE04 - MissingCreditorAddress
  • BE05 - UnrecognisedInitiatingParty
  • BE06 - UnknownEndCustomer
  • BE07 - MissingDebtorAddress
  • DT01 - InvalidDate
  • FF01 - InvalidFileFormat
  • MD01 - NoMandate
  • MD02 - MissingMandatoryInformationInMandate
  • MD07 - EndCustomerDeceased
  • MD08 - NoMandateServiceByAgent
  • MD09 - NoMandateServiceOnCustomer
  • MD10 - NoMandateServiceForSpecified
  • MD11 - UnrecognisedAgent
  • MD12 - NotUniqueMandateReference
  • MD13 - IncorrectCustomerAuthentication
  • MD14 - IncorrectAgent
  • MD15 - IncorrectCurrency
  • MD16 - RequestedByCustomer
  • MD17 - RequestedByInitiatingParty
  • MD18 - RequestedByInitiatingPartyAndCustomer
  • MD19 - MandateCancelledDueToEarlySettlement
  • MD20 - MandateExpired
  • MD21 - MandateCancelledDueToFraud
  • MD22 - MandateInitiationCancelled
  • MD23 - MandateAmendmentCancelled
  • MS02 - NotSpecifiedReasonCustomerGenerated
  • MS03 - NotSpecifiedReasonAgentGenerated
  • NARR - Narrative
  • RC01 - BankIdentifierIncorrect
  • RF01 - NotUniqueTransactionReference
  • RR01 - MissingDebtorAccountOrIdentification
  • RR02 - MissingDebtorNameOrAddress
  • RR03 - MissingCreditorNameOrAddress
  • RR04 - RegulatoryReason
  • SL01 - SpecificServiceOfferedByDebtorAgent
  • SL11 - CreditorNotOnWhitelistOfDebtor
  • SL12 - CreditorOnBlacklistOfDebtor
  • SL13 - MaximumNumberOfDirectDebitTransactionsExceeded
  • SL14 - MaximumDirectDebitTransactionAmountExceeded
Enum"AC01""AC04""AC06""AG01""AG02""AM02""AM03""AM05""BE01""BE04"
originalMandateobject(OriginalMandateReference)required

Reference to an original mandate. The partner may identify the mandate using any of the following identifiers, depending on the context of the request and the information available. At least one of originalMandateIdentification for the original mandate, or originalMandate must be provided.

For mandate amendment, cancellation and suspension requests, originalMandate is required and the originalMandateIdentification cannot be used as the sole reference.

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.

{
  "amendedMandate": {
    "adjustment": { … },
    "authentication": { … },
    "collectionAmount": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "creditorSchemeIdentification": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "firstCollectionAmount": { … },
    "mandateIdentification": "string",
    "mandateReference": "string",
    "mandateRequestIdentification": "string",
    "maximumAmount": { … },
    "occurrences": { … },
    "reason": { … },
    "referredDocument": [ … ],
    "trackingIndicator": true,
    "type": { … },
    "ultimateCreditor": { … },
    "ultimateDebtor": { … }
  },
  "amendmentReason": {
    "additionalInformation": [ … ],
    "originator": { … },
    "reason": { … }
  },
  "originalMandate": {
    "originalMandate": { … },
    "originalMandateIdentification": "string"
  },
  "originalMessageInformation": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string",
    "messageNameIdentification": "string"
  }
}

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd