EPC API for calling Electrum (17.1.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients 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.

Download OpenAPI description
Overview
Languages
Servers
Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/

Payments API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

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

Operations

request-to-pay

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

Operations

Schema

CbprPlusPaymentStatusReportPaymentScheme

schemastringrequired
{ "schema": "string" }

ZaEftPaymentStatusReportPaymentScheme

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.
  • CBPR_PLUS: Cross-Border Payments and Reporting Plus.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"
{ "schema": "ZA_RTC" }

ZaRppPaymentStatusReportPaymentScheme

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.
  • CBPR_PLUS: Cross-Border Payments and Reporting Plus.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"
{ "schema": "ZA_RTC" }

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations