Electrum Regulated Payments API (26.1.1)

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

Languages
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

sanctions-assessment

Operations related to the processing of sanctions assessment for payment transactions.

Operations

mandate-management

Operations related to the lifecycle management of direct debit mandates.

Operations

Schema

SanctionsAssessmentStatus

The outcome of the performed sanctions assessment.

outcomestringrequired

Indicates the outcome of the sanctions assessment of the submitted payment instruction.

  • ALLOWED: Message is allowed to continue along the normal flow.
  • BLOCKED: Message must be blocked.
  • PENDING: The sanctions assessment is still being processed.
  • ERROR: An error occurred while performing the sanctions check for this request and the request is unable to be processed further.
Enum"ALLOWED""BLOCKED""PENDING""ERROR"
reasonCodeanyrequired

Provide the reason for the outcome of the sanctions assessment of the submitted payment instruction.

  • SYSTEM_PROCESSING: The system is performing automated screening on the sanction request.
  • USER_INVESTIGATION_UNDERWAY: A user is performing manual screening on the sanction request.
  • NO_SCREENING_REQUIRED: No screening for the message was required, thus the message was ALLOWED.
  • SCREENED_NO_ALERT: Screening took place but no alert was triggered.
  • SCREENED_NON_BLOCKING_ALERT: Screening took place and an alert was triggered, but the alert did not block the transaction.
  • INVESTIGATION_RESULT: Screening took place and an alert was triggered to require user investigation. The outcome was then decided by the user.
  • ERROR_PROCESSING_REQUEST: An error occurred while performing the sanctions check for this request.
Enum"SYSTEM_PROCESSING""USER_INVESTIGATION_UNDERWAY""NO_SCREENING_REQUIRED""SCREENED_NO_ALERT""SCREENED_NON_BLOCKING_ALERT""INVESTIGATION_RESULT""ERROR_PROCESSING_REQUEST"
reasonDescriptionstring

A human readable description providing additional details as to the reason of the sanctions outcome

{
  "outcome": "ALLOWED",
  "reasonCode": "SYSTEM_PROCESSING",
  "reasonDescription": "string"
}

SanctionsAssessmentReport

This model provides the report of the sanctions assessment outcome.

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.

originalMessageIdentifiersobject(MessageIdentifiers)required

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

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

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

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.​endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.​instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.​transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

transactionIdentifiers.​uetrstring(UUID)required

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

lastUpdatedstring(date-time)required

The latest point the outcome of the sanctions assessment has changed. The date must be formatted as defined by date-time in RFC3339

schemastringrequired
Value"SanctionsAssessmentReport"
statusobject(SanctionsAssessmentStatus)required

The outcome of the performed sanctions assessment.

status.​outcomestringrequired

Indicates the outcome of the sanctions assessment of the submitted payment instruction.

  • ALLOWED: Message is allowed to continue along the normal flow.
  • BLOCKED: Message must be blocked.
  • PENDING: The sanctions assessment is still being processed.
  • ERROR: An error occurred while performing the sanctions check for this request and the request is unable to be processed further.
Enum"ALLOWED""BLOCKED""PENDING""ERROR"
status.​reasonCodeanyrequired

Provide the reason for the outcome of the sanctions assessment of the submitted payment instruction.

  • SYSTEM_PROCESSING: The system is performing automated screening on the sanction request.
  • USER_INVESTIGATION_UNDERWAY: A user is performing manual screening on the sanction request.
  • NO_SCREENING_REQUIRED: No screening for the message was required, thus the message was ALLOWED.
  • SCREENED_NO_ALERT: Screening took place but no alert was triggered.
  • SCREENED_NON_BLOCKING_ALERT: Screening took place and an alert was triggered, but the alert did not block the transaction.
  • INVESTIGATION_RESULT: Screening took place and an alert was triggered to require user investigation. The outcome was then decided by the user.
  • ERROR_PROCESSING_REQUEST: An error occurred while performing the sanctions check for this request.
Enum"SYSTEM_PROCESSING""USER_INVESTIGATION_UNDERWAY""NO_SCREENING_REQUIRED""SCREENED_NO_ALERT""SCREENED_NON_BLOCKING_ALERT""INVESTIGATION_RESULT""ERROR_PROCESSING_REQUEST"
status.​reasonDescriptionstring

A human readable description providing additional details as to the reason of the sanctions outcome

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "lastUpdated": "2019-08-24T14:15:22Z",
  "schema": "SanctionsAssessmentReport",
  "status": {
    "outcome": "ALLOWED",
    "reasonCode": "SYSTEM_PROCESSING",
    "reasonDescription": "string"
  }
}

AdjustmentCategoryCode

Frequency/category of adjustments allowed on a mandate.

  • MIAN - Semi-annually or 2 times a year
  • NEVR - No adjustment allowed
  • QURT - 3 months or 4 times a year
  • RATE - Repo Rate-based adjustment
  • YEAR - Annual adjustment
string(AdjustmentCategoryCode)

Frequency/category of adjustments allowed on a mandate.

  • MIAN - Semi-annually or 2 times a year
  • NEVR - No adjustment allowed
  • QURT - 3 months or 4 times a year
  • RATE - Repo Rate-based adjustment
  • YEAR - Annual adjustment
Enum"MIAN""NEVR""QURT""RATE""YEAR"
"MIAN"

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd