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

elpapi-partner.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

Frequency

Specifies the frequency of the payment transaction.

periodTypestring(FrequencyTypeCode)

YEAR: Annual - event takes place every year or once a year.
MNTH: Monthly - event takes place every month or once a month.
QURT: Quarterly - event takes place every three months or four times a year.
MIAN: Semi-annual - event takes place every six months or two times a year.
WEEK: Weekly - event takes place once a week.
DAIL: Daily - event takes place every day.
ADHO: Ad hoc - event takes place on request or as necessary.
INDA: Intraday - event takes place several times a day.
FRTN: Fortnightly - event takes place every two weeks.

Enum"YEAR""MNTH""QURT""MIAN""WEEK""DAIL""ADHO""INDA""FRTN"

pointInTimestring^[0-9]{2}$

A two-digit number identifying the specific occurrence within the period named by periodType. Its meaning depends entirely on periodType:

YEAR, MNTH, QURT, MIAN: 01-30 is the exact calendar day of the month. 99 is the last day of the month (automatically adjusting for February 28th/29th). 31 is not a valid input.
WEEK: 01 (Monday) to 07 (Sunday).
FRTN: 01-07 is the day of week one of the fortnight (Monday-Sunday); 08-14 is the day of week two.
ADHO: identifies a specific monthly occurrence, per the ZA_AC scheme's proprietary reuse of this code for "monthly by rule" collections (ADHO is never populated here for its ISO meaning of a genuinely irregular/on-demand frequency, which has no pointInTime):
- 01 Last Monday, 02 Last Tuesday, 03 Last Wednesday, 04 Last Thursday, 05 Last Friday, 06 Last Saturday
- 07 First Monday, 08 First Tuesday, 09 First Wednesday, 10 First Thursday, 11 First Friday, 12 First Saturday
- 14 Second Last Day, 99 Last Day
- (13 is not a valid input)

schemastringrequired

Value"POINT_IN_TIME"

Discriminator

{
  "periodType": "YEAR",
  "pointInTime": "string",
  "schema": "POINT_IN_TIME"
}

MandateOccurrences

Defines the frequency and duration of mandate collections.

finalCollectionDatestring(date)

The date of the final collection.

firstCollectionDatestring(date)

The date of the first collection.

frequencyany(Frequency)

Specifies the frequency of the payment transaction.

sequenceTypestring(SequenceTypeCode)required

Identifies the direct debit sequence:

FRST : First collection of a series of direct debit instructions.
RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.
FNAL : Final collection of a series of direct debit instructions.
OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.
RPRE : Collection used to represent previously reversed or returned direct debit transactions.

Enum"FRST""RCUR""FNAL""OOFF""RPRE"

validFromstring(date)

The date from which the mandate is valid.

validTostring(date)

The date until which the mandate is valid.

{
  "finalCollectionDate": "2019-08-24",
  "firstCollectionDate": "2019-08-24",
  "frequency": {
    "periodType": "YEAR",
    "pointInTime": "string",
    "schema": "POINT_IN_TIME"
  },
  "sequenceType": "FRST",
  "validFrom": "2019-08-24",
  "validTo": "2019-08-24"
}

ExternalMandateReasonCode

schemastringrequired

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

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"

{
  "schema": "string",
  "value": "AC01"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations