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

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

ZaRtcPaymentStatusReportPaymentSchemeData

authorisationIdstring<= 6 characters^[\dA-z ]*$

A unique number assigned by the beneficiary bank to identify the transaction if it is approved. Must remain unaltered by the originator.

beneficiaryEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for beneficiary use. Must remain unaltered by the originator.

{
  "authorisationId": "string",
  "beneficiaryEchoData": "string"
}

ZaRtcPaymentStatusReportPaymentScheme

originalSchemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

originalSchemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).

originalSchemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

originalSchemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

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"

schemeDataobject(ZaRtcPaymentStatusReportPaymentSchemeData)required

schemeData.authorisationIdstring<= 6 characters^[\dA-z ]*$

A unique number assigned by the beneficiary bank to identify the transaction if it is approved. Must remain unaltered by the originator.

schemeData.beneficiaryEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for beneficiary use. Must remain unaltered by the originator.

{
  "originalSchemeData": {
    "businessReference": "string",
    "originatorEchoData": "string",
    "userReference": "string"
  },
  "schema": "ZA_RTC",
  "schemeData": {
    "authorisationId": "string",
    "beneficiaryEchoData": "string"
  }
}

PaymentStatusReportPaymentScheme

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

schemastringrequired

Discriminator

{
  "schema": "CBPR_PLUS"
}

operational

Operations

bulk

Operations

request-to-pay

Operations

refund

Operations

account-verification

Operations