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

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

MandateSetupReasonCode

Reason for the direct debit mandate to allow the user to distinguish between different mandates for the same creditor.

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestring[ 1 .. 4 ] charactersrequired

{
  "schema": "string",
  "value": "stri"
}

MandateSetupReason

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestring[ 1 .. 4 ] charactersrequired

{
  "schema": "CODE",
  "value": "stri"
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations