Electrum Regulated Payments API (29.1.0)

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

ZaEftDirectDebitPaymentScheme

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"

schemeDataobject(ZaEftSchemeData)required

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.

schemeData.shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

schemeData.userCodestring<= 4 characters

A code allocated by PayInc. Sometimes also referred to as BankCode. May equal Installation code for in-house operation.

schemeData.userReferencestring<= 30 characters^[\u0020-\u007A]*$required

An explanation of an EFT transaction, which will be printed on the debtor's statement for direct debits or the creditor's statement for credit transfers. Note that when populating a value for a direct debit, the first 10 characters must contain the Banks user code as configured at Bankserv. If configured, Electrum will populate this value automatically, in which case at most 20 characters should be used as a reference to avoid truncation. Allowed characters are limited to printable ASCII U+0020 to U+007A (space through 'z').

{
  "schema": "ZA_RTC",
  "schemeData": {
    "shortenedCreditorAccountNumber": "stringstrin",
    "shortenedDebtorAccountNumber": "stringstrin",
    "userCode": "stri",
    "userReference": "string"
  }
}

DirectDebitPaymentScheme

Designates which scheme a direct debit is associated with and describes scheme-specific information for the direct debit.

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

schemeDataobject(ZaAcSchemeData)required

Scheme-specific data for Authenticated Collections (DebiCheck) direct debits. Unlike EFT, DebiCheck only supports debit transactions (collections), so shortened account numbers used for EFT file generation are not applicable here.

schemeData.creditorAbbreviatedShortNamestring[ 1 .. 10 ] charactersrequired

The Creditor Abbreviated Short Name (ABSN). This is a 3 to 10 character description of the Ultimate Creditor's name, business, or product that will appear on the debtor's bank statement. This value MUST perfectly match the ABSN stored on the active Mandate Register at the Debtor Bank (i.e. must match the short name provided for the ultimateCreditor during mandate initiation). Mismatches will result in scheme rejections.

schemeData.creditorContractReferencestring[ 1 .. 14 ] charactersrequired

The unique contract reference number issued by the Ultimate Creditor to the Payer/Debtor when the contract was concluded. This value MUST perfectly match the Contract Reference stored on the active Mandate Register at the Debtor Bank. (i.e must match the identifier provided for mandate.mandateRequestIdentification during mandate initiation). Mismatches will result in scheme rejections.

schemeData.userReferencestring<= 140 characters^[\u0020-\u007A]*$

Under the DebiCheck scheme, the user reference expected to appear on debtor statements comprises the following:

creditorAbbreviatedShortName - right-padded with spaces to exactly 10 characters (Characters 1–10)
creditorContractReference - right-padded with spaces to exactly 14 characters (Characters 11–24)
requestedCollectionDate (also known as cycle date) - formatted as YYMMDD (Characters 25–30)
The remaining 110 characters are available for bill presentment. This text will also be captured as unstructured remittanceInformation in the DirectDebit. Only the first 30 characters are required to appear on debtor statements. Allowed characters are limited to printable characters.

This field will be provided for all inbound requests to the partner. Do NOT populate this field for outbound requests. Instead, provide any bill presentment text (up to 110 characters) in the DirectDebit model under remittanceInformation.unstructured. The engine will automatically concatenate the Creditor Short Name, Contract Reference, the DirectDebit requestedCollectionDate, and your unstructured remittance text to construct the final 140-character string required by the scheme.

{
  "schema": "ZA_AC",
  "schemeData": {
    "creditorAbbreviatedShortName": "string",
    "creditorContractReference": "string",
    "userReference": "string"
  }
}

SequenceTypeCode

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.

string(SequenceTypeCode)

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"

"FRST"

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations