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

SchemeReport

agentobject(InstitutionIdentification)required
agent.​additionalIdentificationsArray of objects(AccountIdentification)
agent.​addressobject(PostalAddress)
agent.​bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

agent.​branchobject(BranchIdentification)
agent.​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
agent.​leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

agent.​namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

agent.​companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

agent.​memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

domainsArray of objects(ZaInstitutionIdentificationWithDomain)required
domains[].​additionalIdentificationsArray of objects(AccountIdentification)
domains[].​addressobject(PostalAddress)
domains[].​bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

domains[].​branchobject(BranchIdentification)
domains[].​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
domains[].​leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

domains[].​namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

domains[].​domainstring<= 35 characters

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

  • which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier
domains[].​companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

domains[].​memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

schemastringrequired
Discriminator
{
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "domains": [
    { … }
  ],
  "schema": "ZA_RPP_LIST_DOMAINS"
}

ZaInstitutionIdentificationWithDomain

additionalIdentificationsArray of objects(AccountIdentification)
addressobject(PostalAddress)
bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

branchobject(BranchIdentification)
clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

domainstring<= 35 characters

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

  • which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier
companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

{
  "additionalIdentifications": [
    { … }
  ],
  "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"
  },
  "bicfi": "string",
  "branch": {
    "address": { … },
    "identification": "string",
    "name": "string"
  },
  "clearingSystemMemberId": {
    "clearingSystem": { … },
    "memberId": "string"
  },
  "companyRegistration": "string",
  "lei": "string",
  "memberId": "string",
  "name": "string",
  "domain": "string"
}

ZaRppListDomainsSchemeReport

agentobject(InstitutionIdentification)required
agent.​additionalIdentificationsArray of objects(AccountIdentification)
agent.​addressobject(PostalAddress)
agent.​bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

agent.​branchobject(BranchIdentification)
agent.​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
agent.​leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

agent.​namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

agent.​companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

agent.​memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

domainsArray of objects(ZaInstitutionIdentificationWithDomain)required
domains[].​additionalIdentificationsArray of objects(AccountIdentification)
domains[].​addressobject(PostalAddress)
domains[].​bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

domains[].​branchobject(BranchIdentification)
domains[].​clearingSystemMemberIdobject(ClearingSystemMemberIdentification)
domains[].​leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

domains[].​namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

domains[].​domainstring<= 35 characters

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

  • which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier
domains[].​companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

domains[].​memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

schemastringrequired
Discriminator
{
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "domains": [
    { … }
  ],
  "schema": "ZA_RPP_LIST_DOMAINS"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd