EPC API for receiving Electrum calls (19.1.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Download OpenAPI description

epc-elpapi-partner-redoc.json

epc-elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Partner API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

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

Frequency

Specifies the frequency of the payment transaction.

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

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations