EPC API for receiving Electrum calls (17.1.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Download OpenAPI description

epc-elpapi-partner-redoc.json

epc-elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-partner-redoc/

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

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

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations