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

https://electrum.co.za

Electrum Support

support@electrum.co.za

Languages
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

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

Schema

ZaAcSchemeData

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.

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

A reference for the Authenticated Collections (DebiCheck) transaction. This value is mapped to the RmtInf/Ustrd field in the pacs.003 message and will be printed on the debtor's statement. The first 30 characters are guaranteed to appear on statements. Allowed characters are limited to printable ASCII U+0020 to U+007A (space through 'z').

{
  "userReference": "string"
}

ZaAcDirectDebitPaymentScheme

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.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"
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.​userReferencestring<= 30 characters^[\u0020-\u007A]*$required

A reference for the Authenticated Collections (DebiCheck) transaction. This value is mapped to the RmtInf/Ustrd field in the pacs.003 message and will be printed on the debtor's statement. The first 30 characters are guaranteed to appear on statements. Allowed characters are limited to printable ASCII U+0020 to U+007A (space through 'z').

{
  "schema": "ZA_RTC",
  "schemeData": {
    "userReference": "string"
  }
}

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.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"
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

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.​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",
    "userReference": "string"
  }
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd