Getting Started

Warning

The API and supporting material presented here is in an alpha state and is therefore under constant revision.

We are making this content available as a preview so that implementers can get familiar with the general structure and concepts employed by the solution. Please use the resources with caution until a stable release of the API is available.

Overview

The Electrum Regulated Payments Platform facilitates inter-bank credit transfers between participants connected via an electronic payment scheme. The supported schemes currently include the Rapid Payments Programme (RPP) and Real-Time Clearing (RTC). There will be future support for Electronic Funds Transfer (EFT) Credit payments.

This developer portal contains the guides and reference material you'll need to get connected to the various payment schemes that are supported by the Electrum platform.

Using the Portal

The Implementation Guides section contains everything you need to get up and running with a working integration, including:

General information about communication protocols and scheme features, such as:
Step-by-step guides on how to receive and send payments using the Electrum APIs.
Details about additional services that you may use as part of your implementation, specifically:
- Account and proxy management
- Events publisher

Full reference pages and downloadable OpenAPI specifications are provided for the APIs:

The Electrum Regulated Payments API , which specifies the operations that are exposed by Electrum for you to consume.
The Electrum Regulated Payments Partner API , which specifies the operations that you will need to implement for Electrum to consume.
The Electrum Regulated Payments Events API , which defines informational event notifications that the Electrum platform emits during the course of transaction processing.