RegulatoryAuthority

EPC API for receiving Electrum calls (17.1.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Charge

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.

amountobject(Amount)required

amount.currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

amount.valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency Code	Example	Valid	Notes
USD	10.0	✓	Represents 10 USD and no cents.
USD	10.00	✓
USD	10.001	✗	US dollar does not support three decimal places.
JPY	10.0	✓	Represents 10 Japanese Yen.
JPY	10.1	✗	Japanese Yen does not support decimal places.

typeobject(ChargeType)

{
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "amount": {
    "currency": "string",
    "value": 0.1
  },
  "type": {
    "schema": "string",
    "value": "BRKF"
  }
}

RegulatoryAuthority

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

namestring<= 140 characters

The name of the entity requiring the regulatory reporting information

{
  "country": "string",
  "name": "string"
}

RegulatoryReportingDetail

additionalInformationArray of strings

Additional details that cater for specific domestic regulatory requirements

amountobject(Amount)

codestring<= 10 characters

Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.

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

datestring(date)

typestring<= 35 characters

Specifies the type of the information supplied in the regulatory reporting detail

{
  "additionalInformation": [
    "string"
  ],
  "amount": {
    "currency": "string",
    "value": 0.1
  },
  "code": "string",
  "country": "string",
  "date": "2019-08-24",
  "type": "string"
}

EPC API for receiving Electrum calls (17.1.0)

credit-transfer

identifier-determination

Schema

Charge

RegulatoryAuthority

RegulatoryReportingDetail

transactional

request-to-pay

financial

bulk

refund