RegulatoryReporting

Electrum Regulated Payments Partner API (17.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

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

RegulatoryReporting

applicabilitystring

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Enum"CREDIT""DEBIT""BOTH"

authorityobject(RegulatoryAuthority)

detailsArray of objects(RegulatoryReportingDetail)

{
  "applicability": "CREDIT",
  "authority": {
    "country": "string",
    "name": "string"
  },
  "details": [
    { … }
  ]
}

CbprPlusCustomerCreditSchemeData

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

chargeBearerstring(ChargeBearer)required

DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme

Enum"DEBT""CRED""SHAR""SLEV"

chargesArray of objects(Charge)

exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items

{
  "chargeBearer": "DEBT",
  "charges": [
    { … }
  ],
  "exchangeRate": 0.1,
  "regulatoryReporting": [
    { … }
  ]
}

Electrum Regulated Payments Partner API (17.1.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

Schema