EPC API for calling Electrum (19.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

epc-elpapi-redoc.json

epc-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/

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

YearlyFrequency

Base model for payment transaction frequencies expressed in terms of days of the month. Not expected to be used directly; see MonthlyFrequency, QuarterlyFrequency, BiannualFrequency and YearlyFrequency.

dayOfMonthinteger[ 1 .. 31 ]required

Specifies the day of the month on which the payment transaction is to be processed. NOTE: A value of 31 will be interpreted as the last day of the month.

schemastringrequired

Enum"MonthlyFrequency""QuarterlyFrequency""BiannualFrequency""YearlyFrequency"

Discriminator

{
  "dayOfMonth": 1,
  "schema": "BiannualFrequency"
}

DayOfWeek

Specifies a day of the week.

string(DayOfWeek)

Specifies a day of the week.

Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"

"MONDAY"

FortnightlyFrequency

Specifies the frequency of a fortnightly payment transaction.

dayOfWeekstring(DayOfWeek)required

Specifies a day of the week.

Enum"MONDAY""TUESDAY""WEDNESDAY""THURSDAY""FRIDAY""SATURDAY""SUNDAY"

schemastringrequired

Value"FortnightlyFrequency"

weekstringrequired

Identifies the week of the fortnight on which the payment transaction is to be processed.

FIRST_WEEK: First week of the fortnight.
SECOND_WEEK: Second week of the fortnight.

Enum"FIRST_WEEK""SECOND_WEEK"

{
  "dayOfWeek": "MONDAY",
  "schema": "FortnightlyFrequency",
  "week": "FIRST_WEEK"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations