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

OrganisationIdentifierOther

A unique identification of an organisation, as assigned by an institution, using an identification scheme.

identificationstring<= 35 charactersrequired

issuerstring<= 35 characters

The name of the entity that assigns the identification

schemastringrequired

Indicates the identifier as a unique identification of an organisation, as assigned by an institution. Always OTHER

schemeobject(OrganisationIdentifierScheme)

{
  "identification": "string",
  "issuer": "string",
  "schema": "string",
  "scheme": {
    "schema": "string",
    "value": "BANK"
  }
}

OrganisationIdentifier

Holds identification details for an organisation.

BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

{
  "BIC": "string",
  "schema": "BIC"
}

OrganisationIdentification

identifiersArray of objects(OrganisationIdentifier)required

identifiers[].BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

identifiers[].schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

schemastringrequired

Identifies the party as an organisation, always ORGANISATION

{
  "identifiers": [
    { … }
  ],
  "schema": "string"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations