Electrum Regulated Payments API (21.0.2)

The Electrum Regulated Payments API is an asynchronous API that allows partners 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.

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 this document.
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 the Electrum Regulated Payments Partner API.

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. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.

Download OpenAPI description

elpapi-redoc.json

elpapi-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

License

proprietary

Servers

Payments API sandbox

https://example.com/path/payments/api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

refund

Operations related to the refund of a prior successful financial transaction.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

Schema

AccountStatusCode

A set of codes that describe the status of an account

string(AccountStatusCode)

A set of codes that describe the status of an account

Enum"ENABLED""DISABLED""DELETED"

"ENABLED"

Account

An account within the Electrum Account mirror. Note that the primaryIdentification is permanent and immutable.

accountNamestring<= 70 characters

additionalIdentificationsArray of objects(AccountIdentification)

currencystring(CurrencyCode)^[A-Z]{3}$

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

openingDatestring(date-time)

Date and time at which the account was established.

primaryIdentificationobject(AccountIdentification)required

Holds details pertaining to an identifier of an account or store of value.

primaryIdentification.accountKnownAsstring<= 40 characters

A name or label of the account.

primaryIdentification.identifierobject(AccountIdentifier)required

primaryIdentification.identifier.namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

ZA_RPP

primaryIdentification.identifier.schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator

primaryIdentification.identifier.valuestring[ 1 .. 2048 ] charactersrequired

primaryIdentification.registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

Items Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"

restrictionsArray of objects(Restriction)

statusstring(AccountStatusCode)

A set of codes that describe the status of an account

Enum"ENABLED""DISABLED""DELETED"

typeobject(AccountType)

{
  "accountName": "string",
  "additionalIdentifications": [
    { … }
  ],
  "currency": "string",
  "openingDate": "2019-08-24T14:15:22Z",
  "primaryIdentification": {
    "accountKnownAs": "string",
    "identifier": { … },
    "registeredSchemes": [ … ]
  },
  "restrictions": [
    { … }
  ],
  "status": "ENABLED",
  "type": {
    "schema": "string",
    "value": "CACC"
  }
}

AccountOwner

Contains information detailing the owner of an account, which can be either a person or organisation.

recordIdentifierstring[ 1 .. 50 ] charactersrequired

A unique identifier used to identify this Account Owner record. This is distinct from the identification of the Account Owner, which may or may not be unique within this system, but which is typically used for identification outside of the system, such as passport numbers or national identification numbers. This identifier is used exclusively to identify the owner within this system.

schemastringrequired

Defines the type of owner.

Enum"ORGANISATION""INDIVIDUAL"

Discriminator

addressobject(PostalAddress)

contactDetailsobject(ContactDetails)

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

identifiersArray of objects(PersonIdentifier)

nameobject(PersonName)

Name of the person.

{
  "recordIdentifier": "string",
  "schema": "INDIVIDUAL",
  "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"
  },
  "contactDetails": {
    "emailAddress": "user@example.com",
    "mobileNumber": "string",
    "phoneNumber": "string"
  },
  "countryOfResidence": "string",
  "identifiers": [
    { … }
  ],
  "name": {
    "additionalNames": "string",
    "firstName": "string",
    "initials": "string",
    "knownAs": "string",
    "lastName": "string",
    "title": "string"
  }
}

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations