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

ZaRppProxyIdentifierSchemeDeregistration

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

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

Discriminator

participantobject(InstitutionIdentification)

registeredAccountIdobject(AccountIdentifier)required

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

registeredAccountId.schemastringrequired

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

Discriminator

registeredAccountId.valuestring[ 1 .. 2048 ] charactersrequired

{
  "schema": "ZA_RPP",
  "participant": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "registeredAccountId": {
    "schema": "string",
    "value": "string"
  }
}

IdentifierSchemeDeregistrationRequest

Holds details of an account identifier and other information required to deregister the identifier. externally with a scheme.

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.

schemastringrequired

Value"IdentifierSchemeDeregistrationRequest"

schemeDeregistrationobject(SchemeDeregistration)required

schemeDeregistration.schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

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

Discriminator

schemeDeregistration.participantobject(InstitutionIdentification)

schemeDeregistration.registeredAccountIdobject(AccountIdentifier)required

schemeDeregistration.registeredAccountId.namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

schemeDeregistration.registeredAccountId.schemastringrequired

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

Discriminator

schemeDeregistration.registeredAccountId.valuestring[ 1 .. 2048 ] charactersrequired

uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference. This identifier remains the same for all messages related to the same transaction.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "schema": "IdentifierSchemeDeregistrationRequest",
  "schemeDeregistration": {
    "schema": "ZA_RTC"
  },
  "uetr": "string"
}

SchemeDeregistrationOutcome

deregistrationStatusstringrequired

Enum"ACCEPTED""REJECTED"

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

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

Discriminator

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.

proxyobject(NonBankingIdentifier)required

proxy.namespacestring[ 1 .. 40 ] characters

This may be used by the following schemes:

ZA_RPP

proxy.schemastringrequired

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

Discriminator

proxy.valuestring[ 1 .. 2048 ] charactersrequired

reasonCodestring

AB06 : Timeout
AB07 : OfflineAgent
AB10 : ErrorInstructedAgent
AG03 : TransactionNotSupported
AG10 : AgentSuspended
AM18 : InvalidNumberOfTransactions
CH21 : RequiredCompulsoryElementMissing
DT02 : InvalidCreationDate
DUPL : DuplicateRequest
FF02 : SyntaxError
NAUT : NotAuthorised
PD01 : ProxyDomainInvalid
PX02 : InvalidProxy
PX03 : ProxyNotFound
PX04 : ProxyFormatInvalid
PX05 : Restricted Proxy
PX06 : Default proxy already exists
RC02 : InvalidBankIdentifier
RC08 : InvalidClearingSystemMemberIdentifier
RR10 : InvalidCharacterSet
RR12 : InvalidPartyID

Enum"AB06""AB07""AB10""AG03""AG10""AM18""CH21""DT02""DUPL""FF02"

{
  "deregistrationStatus": "ACCEPTED",
  "schema": "ZA_RPP",
  "agent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "proxy": {
    "namespace": "string",
    "schema": "string"
  },
  "reasonCode": "AB06"
}

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations