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

CountryCode

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

string(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

"string"

PostalAddress

addressLineArray of strings[ 0 .. 7 ] items
addressTypestring(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"
buildingNamestring[ 1 .. 35 ] characters
buildingNumberstring[ 1 .. 16 ] characters
countrystring(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

countrySubDivisionstring[ 1 .. 35 ] characters
departmentstring[ 1 .. 70 ] characters
districtNamestring[ 1 .. 35 ] characters
floorstring[ 1 .. 70 ] characters
postBoxstring[ 1 .. 16 ] characters
postCodestring[ 1 .. 16 ] characters
roomstring[ 1 .. 70 ] characters
streetNamestring[ 1 .. 70 ] characters
subDepartmentstring[ 1 .. 70 ] characters
townLocationNamestring[ 1 .. 35 ] characters
townNamestring[ 1 .. 35 ] characters
{
  "addressLine": [
    "string"
  ],
  "addressType": "ADDR",
  "buildingName": "string",
  "buildingNumber": "string",
  "country": "string",
  "countrySubDivision": "string",
  "department": "string",
  "districtName": "string",
  "floor": "string",
  "postBox": "string",
  "postCode": "string",
  "room": "string",
  "streetName": "string",
  "subDepartment": "string",
  "townLocationName": "string",
  "townName": "string"
}

BranchIdentification

addressobject(PostalAddress)
identificationstringrequired

Unique and unambiguous identification of a branch of a financial institution.

namestring<= 140 characters

The name by which this branch is known and is usually used to identify the branch.

{
  "address": {
    "addressLine": [ … ],
    "addressType": "ADDR",
    "buildingName": "string",
    "buildingNumber": "string",
    "country": "string",
    "countrySubDivision": "string",
    "department": "string",
    "districtName": "string",
    "floor": "string",
    "postBox": "string",
    "postCode": "string",
    "room": "string",
    "streetName": "string",
    "subDepartment": "string",
    "townLocationName": "string",
    "townName": "string"
  },
  "identification": "string",
  "name": "string"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd