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

SchemeInquiryRequest

A model containing the foundational elements shared across messages and generally expected in a message used during processing with the Electrum Regulated Payments API.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

inquiryobject(SchemeInquiry)required

inquiry.agentobject(InstitutionIdentification)required

inquiry.agent.additionalIdentificationsArray of objects(AccountIdentification)

inquiry.agent.addressobject(PostalAddress)

inquiry.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)

inquiry.agent.branchobject(BranchIdentification)

inquiry.agent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

inquiry.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).

inquiry.agent.namestring<= 140 characters

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

inquiry.agent.companyRegistrationstring<= 35 charactersDeprecated

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

inquiry.agent.memberIdstring<= 35 charactersDeprecated

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

inquiry.schemastringrequired

Discriminator

schemastringrequired

Value"SchemeInquiryRequest"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "inquiry": {
    "schema": "string"
  },
  "schema": "SchemeInquiryRequest"
}

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...

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...

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...

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"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations