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

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"
}

MonthlyRuleFrequency

Specifies the frequency of a monthly payment transaction by a special rule, e.g. "the last monday of the month".

rulestringrequired

Specifies the day of the month on which the payment transaction is to be processed.

LAST_MONDAY: Last Monday of the month.
LAST_TUESDAY: Last Tuesday of the month.
LAST_WEDNESDAY: Last Wednesday of the month.
LAST_THURSDAY: Last Thursday of the month.
LAST_FRIDAY: Last Friday of the month.
LAST_SATURDAY: Last Saturday of the month.
FIRST_MONDAY: First Monday of the month.
FIRST_TUESDAY: First Tuesday of the month.
FIRST_WEDNESDAY: First Wednesday of the month.
FIRST_THURSDAY: First Thursday of the month.
FIRST_FRIDAY: First Friday of the month.
FIRST_SATURDAY: First Saturday of the month.
SECOND_LAST_DAY: Second last day of the month.
LAST_DAY: Last day of the month.

Enum"LAST_MONDAY""LAST_TUESDAY""LAST_WEDNESDAY""LAST_THURSDAY""LAST_FRIDAY""LAST_SATURDAY""FIRST_MONDAY""FIRST_TUESDAY""FIRST_WEDNESDAY""FIRST_THURSDAY"

schemastringrequired

Value"MonthlyRuleFrequency"

{
  "rule": "LAST_MONDAY",
  "schema": "MonthlyRuleFrequency"
}

WeeklyFrequency

Specifies the frequency of a weekly payment transaction.

dayOfWeekstring(DayOfWeek)required

Specifies a day of the week.

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

schemastringrequired

Value"WeeklyFrequency"

{
  "dayOfWeek": "MONDAY",
  "schema": "WeeklyFrequency"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations