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

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

GenericAccountIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

valuestring[ 1 .. 40 ] charactersrequired

{
  "issuer": "string",
  "schema": "string",
  "scheme": {
    "schema": "string",
    "value": "AIIN"
  },
  "value": "string"
}

IBAN

An identifier used internationally by financial institutions to uniquely identify the account of a customer at a financial institution, as described in the latest edition of the international standard ISO 13616: 2007

string(IBAN)[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

"string"

IBANIdentifier

schemastringrequired

Indicates the account identifier is an IBAN, always IBAN

valuestring(IBAN)[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}required

{
  "schema": "string",
  "value": "string"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations