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

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

MandateAmendmentReason

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.

additionalInformationArray of strings

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.

reasonobject(MandateReason)required

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

reason.schemastringrequired

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

Discriminator

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"

{
  "additionalInformation": [
    "string"
  ],
  "originator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "reason": {
    "schema": "string",
    "value": "AC01"
  }
}

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"
}

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations