Electrum Regulated Payments API (15.2.0)

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.json
elpapi.yaml
Overview
URL https://electrum.co.za
Electrum Support support@electrum.co.za
License proprietary
Languages
Servers
Mock server
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/
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

Schema

operational

Operations

Do a system health check

Request

This synchronous operation reports on the overall health of the system.

Headers
traceparentstring(traceparent)^[A-Fa-f0-9]{2}\-[A-Fa-f0-9]{32}\-[A-Fa-f0-9]...

A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

tracestatestring(tracestate)^[A-Za-z0-9=, _\*/@]{0,1024}$

A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.

curl -i -X GET \
  https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi/health \
  -H 'traceparent: string' \
  -H 'tracestate: string'

Responses

Bodyapplication/json
statusstringrequired
  • PASS: The service is healthy
  • FAIL: The service is unhealthy
  • WARN: The service is healthy with some concerns
Enum"PASS""FAIL""WARN"
versionstring

The version of the service

detailArray of objects(HealthDetail)
Response
application/json
{
  "status": "PASS",
  "version": "string",
  "detail": [
    { … }
  ]
}

bulk

Operations

accounts

Operations

account-verification

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd