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

PaymentSchemeName

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

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

AccountIdentification

Holds details pertaining to an identifier of an account or store of value.

accountKnownAsstring<= 40 characters

A name or label of the account.

identifierobject(AccountIdentifier)required
identifier.​namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

  • ZA_RPP
identifier.​schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator
identifier.​valuestring[ 1 .. 2048 ] charactersrequired
registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

Items Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"
{
  "accountKnownAs": "string",
  "identifier": {
    "schema": "string",
    "value": "string"
  },
  "registeredSchemes": [
    "ZA_RTC"
  ]
}

AddressTypeCode

  • ADDR: A postal address.
  • PBOX: A postal office (PO) box address.
  • HOME: A (residential) home address.
  • BIZZ: A business address.
  • MLTO: Address to which mail is sent.
  • DLVY: Address to which delivery is to take place
string(AddressTypeCode)
  • ADDR: A postal address.
  • PBOX: A postal office (PO) box address.
  • HOME: A (residential) home address.
  • BIZZ: A business address.
  • MLTO: Address to which mail is sent.
  • DLVY: Address to which delivery is to take place
Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
"ADDR"

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd