Electrum Regulated Payments Partner API (17.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.json
elpapi-partner.yaml
Overview
URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Languages
Servers
Mock server

https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/

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

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

Schema

ReturnReasonInfo

Provides detailed information on the return reason.

additionalInformationstring

A human friendly description of the return reason including any further details if applicable.

reasonobject(ReturnReasonType)required
reason.​schemastringrequired

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

Discriminator
reason.​valuestringrequired
  • AC01: IncorrectAccountNumber
  • AC03: InvalidCreditorAccountNumber
  • AC04: ClosedAccountNumber
  • AC06: BlockedAccount
  • AC13: InvalidDebtorAccountType
  • AC14: InvalidAgent
  • AC15: AccountDetailsChanged
  • AC16: AccountInSequestration
  • AC17: AccountInLiquidation
  • AG01: TransactionForbidden
  • AG02: InvalidBankOperationCode
  • AM01: ZeroAmount
  • AM02: NotAllowedAmount
  • AM03: NotAllowedCurrency
  • AM04: InsufficientFunds
  • AM05: Duplication
  • AM06: TooLowAmount
  • AM07: BlockedAmount
  • AM09: WrongAmount
  • AM10: InvalidControlSum
  • ARDT: AlreadyReturnedTransaction
  • BE01: InconsistenWithEndCustomer
  • BE04: MissingCreditorAddress
  • BE05: UnrecognisedInitiatingParty
  • BE06: UnknownEndCustomer
  • BE07: MissingDebtorAddress
  • BE08: BankError
  • CN01: AuthorisationCancelled
  • CNOR: CreditorBankIsNotRegistered
  • CNPC: CashNotPickedUp
  • CURR: IncorrectCurrency
  • CUST: RequestedByCustomer
  • DNOR: DebtorBankIsNotRegistered
  • DS28: ReturnForTechnicalReason
  • DT01: InvalidDate
  • DT02: ChequeExpired
  • ED01: CorrespondentBankNotPossible
  • ED03: BalanceInfoRequest
  • ED05: SettlementFailed
  • EMVL: EMVLiabilityShift
  • ERIN: ERIOptionNotSupported
  • FF05: InvalidLocalInstrumentCode
  • FOCR: FollowingCancellationRequest
  • FR01: Fraud
  • FRTR: FinalResponseMandateCancelled
  • MD01: NoMandate
  • MD02: MissingMandatoryInformationInMandate
  • MD06: RefundRequestByEndCustomer
  • MD07: EndCustomerDeceased
  • MS02: NotSpecifiedReasonCustomerGenerated
  • MS03: NotSpecifiedReasonAgentGenerated
  • NARR: Narrative
  • NOAS: NoAnswerFromCustomer
  • NOCM: NotCompliant
  • NOOR: NoOriginalTransactionReceived
  • PINL: PINLiabilityShift
  • RC01: BankIdentifierIncorrect
  • RC07: InvalidCreditorBICIdentifier
  • RF01: NotUniqueTransactionReference
  • RR01: MissingDebtorAccountOrIdentification
  • RR02: MissingDebtorNameOrAddress
  • RR03: MissingCreditorNameOrAddress
  • RR04: RegulatoryReason
  • RUTA: ReturnUponUnableToApply
  • SL01: SpecificServiceOfferedByDebtorAgent
  • SL02: SpecificServiceOfferedByCreditorAgent
  • SL11: CreditorNotOnWhitelistOfDebtor
  • SL12: CreditorOnBlacklistOfDebtor
  • SL13: MaximumNumberOfDirectDebitTransactionsExceeded
  • SL14: MaximumDirectDebitTransactionAmountExceeded
  • SP01: PaymentStopped
  • SP02: PreviouslyStopped
  • SVNR: ServiceNotRendered
  • TM01: CutOffTime
  • TRAC: RemovedFromTracking
  • UPAY: UnduePayment
  • AGNT: IncorrectAgent
  • FF06: InvalidCategoryPurposeCode
  • RC08: InvalidClearingSystemMemberIdentifier
  • BE11: InvalidCreditorCountry
  • BE17: InvalidCreditorIdentificationCode
  • AC02: InvalidDebtorAccountNumber
  • RR11: InvalidDebtorAgentServiceIdentification
  • BE10: InvalidDebtorCountry
  • BE16: InvalidDebtorIdentificationCode
  • RC11: InvalidIntermediaryAgent
  • RR12: InvalidPartyIdentification
  • FF03: InvalidPaymentTypeInformation
  • FF07: InvalidPurpose
  • FF04: InvalidServiceLevelCode
  • RR09: InvalidStructuredCreditorReference
  • RR05: RegulatoryInformationInvalid
  • RR07: RemittanceInformationInvalid
  • RR08: RemittanceInformationTruncated
  • RR06: TaxInformationInvalid
  • AG07: UnsuccesfulDirectDebit
  • G004: CreditPendingFunds
  • MD05: CollectionNotDue
  • AC07: ClosedCreditorAccountNumber
Enum"AC01""AC03""AC04""AC06""AC13""AC14""AC15""AC16""AC17""AG01"
{
  "additionalInformation": "string",
  "reason": {
    "schema": "string",
    "value": "AC01"
  }
}

PaymentReturn

A model containing the necessary information to request a return of funds after settlement of credit transfer instructions or direct debit instructions.

NOTE: Neither creditorAccount nor debtorAccount are required fields, but creditorAccount is expected to be present for returns of direct debits, and similarly debtorAccount is expected to be present for returns of credit transfers.

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.

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.​endToEndIdentificationstring<= 35 charactersrequired

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.

transactionIdentifiers.​instructionIdentificationstring<= 35 characters

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.

transactionIdentifiers.​transactionIdentificationstring<= 35 characters

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.

transactionIdentifiers.​uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

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.

creditor.​addressobject(PostalAddress)
creditor.​contactDetailsobject(ContactDetails)
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).

creditor.​identificationobject(PartyIdentification)

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

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.

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).

creditorAccountobject(PaymentAccount)

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

creditorAgentobject(InstitutionIdentification)required
creditorAgent.​additionalIdentificationsArray of objects(AccountIdentification)
creditorAgent.​addressobject(PostalAddress)
creditorAgent.​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)

creditorAgent.​branchobject(BranchIdentification)
creditorAgent.​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
creditorAgent.​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).

creditorAgent.​namestring<= 140 characters

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

creditorAgent.​companyRegistrationstring<= 35 charactersDeprecated

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

creditorAgent.​memberIdstring<= 35 charactersDeprecated

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

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.

debtor.​addressobject(PostalAddress)
debtor.​contactDetailsobject(ContactDetails)
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).

debtor.​identificationobject(PartyIdentification)

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

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.

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).

debtorAccountobject(PaymentAccount)

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

debtorAgentobject(InstitutionIdentification)required
debtorAgent.​additionalIdentificationsArray of objects(AccountIdentification)
debtorAgent.​addressobject(PostalAddress)
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)

debtorAgent.​branchobject(BranchIdentification)
debtorAgent.​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
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).

debtorAgent.​namestring<= 140 characters

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

debtorAgent.​companyRegistrationstring<= 35 charactersDeprecated

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

debtorAgent.​memberIdstring<= 35 charactersDeprecated

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

instructedAgentobject(InstitutionIdentification)
instructingAgentobject(InstitutionIdentification)
originalMessageIdentifiersobject(MessageIdentifiers)

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

originalTransactionDataobject(OriginalTransactionData)

Contains key elements related to the original transaction that is being referred to.

paymentSchemeobject(PaymentReturnPaymentScheme)required

Designates which scheme a payment return is associated with and describes scheme-specific information for the return.

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.
  • CBPR_PLUS: Cross-Border Payments and Reporting Plus.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"
Discriminator
paymentScheme.​schemeDataobject(ZaEftPaymentReturnPaymentSchemeData)required
paymentScheme.​schemeData.​returnTypestringrequired

Identifies the type of EFT payment return.

  • UNPAID: Occurs when a payment cannot be completed successfully by the homing bank such as due to insufficient funds or account closure. Note that it is impossible for Electrum to reject unpaids received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound unpaids.
  • DISPUTE: Occurs when there is a disagreement between the creditor and debtor regarding a payment and, after investigation with the assistance of their respective banks, the creditor's bank (in the case of a credit) or the debtor's bank (in the case of a debit) decides that the payment should be returned. As for unpaids, it is impossible for Electrum to reject disputes received from industry, so a negative payment return response results in a reconciliation exception for inbound disputes.
  • SYSTEM_ERROR_CORRECTION_REQUEST: Only expected for inbound use and represents the case where a bank from industry has experienced a technical issue that resulted in payments to or from the partner bank being reflected incorrectly (e.g. credits or debits were duplicated) and the industry bank is requesting that the partner bank attempt to correct the error. This case is notably different from unpaids and disputes in that (1) the system error correction request is expected to be best effort and may be rejected by the partner bank if the request cannot be honoured (e.g. due to insufficient funds) and (2) the bank from industry may retry system error correction requests for the same transaction on different days if an earlier request was rejected.
  • HOME_BACK: Occurs when a payment cannot be completed successfully at the operator such as a lack of information required to route to the correct homing bank. Note that it is impossible for Electrum to reject homebacks received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound homebacks.
Enum"UNPAID""DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST""HOME_BACK"
paymentScheme.​schemeData.​shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

paymentScheme.​schemeData.​shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

paymentTypeInformationobject(PaymentTypeInformation)
reasonInfoArray of objects(ReturnReasonInfo)non-empty

A list of ReturnReasonInfo values providing detailed reason information for the return.

returnedAmountsobject(TransactionAmounts)required
returnedAmounts.​bankSettlementAmountobject(Amount)required
returnedAmounts.​bankSettlementAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

returnedAmounts.​bankSettlementAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
returnedAmounts.​instructedAmountobject(Amount)
schemastringrequired
Value"PaymentReturn"
settlementDatestring(date)

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.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "creditor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "creditorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtor": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "debtorAccount": {
    "currency": "string",
    "identification": { … },
    "name": "string",
    "proxy": { … },
    "type": { … }
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "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"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "originalTransactionData": {
    "amounts": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "paymentMethod": "CreditTransfer",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "settlementDate": "2019-08-24",
    "supplementaryData": { … },
    "creditor": { … },
    "debtor": { … }
  },
  "paymentScheme": {
    "schema": "ZA_RTC",
    "schemeData": { … }
  },
  "paymentTypeInformation": {
    "categoryPurpose": { … },
    "localInstrument": { … },
    "serviceLevel": [ … ]
  },
  "reasonInfo": [
    { … }
  ],
  "returnedAmounts": {
    "bankSettlementAmount": { … },
    "instructedAmount": { … }
  },
  "schema": "PaymentReturn",
  "settlementDate": "2019-08-24"
}

RequestToPayConditions

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

maxAmountobject(Amount)required
maxAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

maxAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
minAmountobject(Amount)required
minAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

minAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
{
  "maxAmount": {
    "currency": "string",
    "value": 0.1
  },
  "minAmount": {
    "currency": "string",
    "value": 0.1
  }
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd