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

TaxRemittance

creditorobject(TaxParty)
datestring(date)

Date by which tax is due

debtorobject(AuthorisedTaxParty)
referenceNumberstring[ 1 .. 140 ] characters

Tax reference information that is specific to a taxing agency.

sequenceNumberinteger(int64)

Sequential number of the tax report.

totalTaxAmountobject(Amount)
totalTaxableBaseAmountobject(Amount)
ultimateDebtorobject(AuthorisedTaxParty)
{
  "creditor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string"
  },
  "date": "2019-08-24",
  "debtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  },
  "referenceNumber": "string",
  "sequenceNumber": 0,
  "totalTaxAmount": {
    "currency": "string",
    "value": 0.1
  },
  "totalTaxableBaseAmount": {
    "currency": "string",
    "value": 0.1
  },
  "ultimateDebtor": {
    "registrationIdentification": "string",
    "taxIdentification": "string",
    "taxType": "string",
    "authorisation": { … }
  }
}

StructuredRemittanceInformation

additionalRemittanceInformationArray of strings<= 3 items
creditorReferenceobject(CreditorReference)
invoicerobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

originatorReferencestring<= 35 characters

An explanation of the transaction, this field may be used to capture the information which may then be displayed on the payment originator's bank statement (ie. the debtor for a credit transfer or the creditor for a direct debit). This field is not supported by all Electrum partner implementations, and will be ignored if provided in an unsupported use-case.

referredDocumentAmountobject(ReferredDocumentAmount)
referredDocumentsArray of objects(ReferredDocument)
taxRemittanceobject(TaxRemittance)
{
  "additionalRemittanceInformation": [
    "string"
  ],
  "creditorReference": {
    "reference": "string",
    "type": { … }
  },
  "invoicer": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "originatorReference": "string",
  "referredDocumentAmount": {
    "duePayableAmount": { … },
    "remittedAmount": { … }
  },
  "referredDocuments": [
    { … }
  ],
  "taxRemittance": {
    "creditor": { … },
    "date": "2019-08-24",
    "debtor": { … },
    "referenceNumber": "string",
    "sequenceNumber": 0,
    "totalTaxAmount": { … },
    "totalTaxableBaseAmount": { … },
    "ultimateDebtor": { … }
  }
}

RemittanceInformation

structuredArray of objects(StructuredRemittanceInformation)
unstructuredArray of strings
{
  "structured": [
    { … }
  ],
  "unstructured": [
    "string"
  ]
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd