EPC API for calling Electrum (17.1.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients 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.

Download OpenAPI description
epc-elpapi-redoc.json
epc-elpapi-redoc.yaml
Overview
URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Languages
Servers
Mock server

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

Payments API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

Schema

CbprPlusCreditTransferPaymentScheme

schemastringrequired
schemeDataobject(CbprPlusCustomerCreditSchemeData)required

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

schemeData.​chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
schemeData.​chargesArray of objects(Charge)
schemeData.​exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

schemeData.​regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
{
  "schema": "string",
  "schemeData": {
    "chargeBearer": "DEBT",
    "charges": [ … ],
    "exchangeRate": 0.1,
    "regulatoryReporting": [ … ]
  }
}

ShortenedAccountNumber

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.

string(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.

"stringstrin"

ZaEftSchemeData

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.

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.

userReferencestring<= 30 charactersrequired

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.

{
  "shortenedCreditorAccountNumber": "stringstrin",
  "shortenedDebtorAccountNumber": "stringstrin",
  "userReference": "string"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd