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

PaymentTypeInformation

categoryPurposeobject(CategoryPurpose)
localInstrumentobject(LocalInstrumentType)
serviceLevelArray of objects(ServiceLevel)
{
  "categoryPurpose": {
    "schema": "string",
    "value": "BONU"
  },
  "localInstrument": {
    "schema": "string",
    "value": "0000"
  },
  "serviceLevel": [
    { … }
  ]
}

CreditorReferenceType

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"
Discriminator
valuestringrequired
  • RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
  • RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
  • FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
  • DISP (DispatchAdvice): Document is a dispatch advice.
  • PUOR (PurchaseOrder): Document is a purchase order.
  • SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.
Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"
{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

CreditorReferenceTypeCode

Specifies the type of creditor reference.

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"
Discriminator
valuestringrequired
  • RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
  • RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
  • FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
  • DISP (DispatchAdvice): Document is a dispatch advice.
  • PUOR (PurchaseOrder): Document is a purchase order.
  • SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.
Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"
{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd