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

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

MandateInformation

Provides details of the direct debit mandate signed between the creditor and the debtor.

NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).

dateOfSignaturestring(date)

Date on which the direct debit mandate has been signed by the debtor.

electronicSignaturestring<= 1025 characters

A digital signature provided by the debtor.

finalCollectionDatestring(date)

Date of the final collection of a direct debit as per the mandate.

firstCollectionDatestring(date)

Date of the first collection of a direct debit as per the mandate.

frequencyobject(Frequency)

Specifies the frequency of the payment transaction.

mandateIdentificationstring<= 35 characters

Unique identification, as assigned by the creditor, to unambiguously identify the mandate.

reasonobject(MandateSetupReason)

trackingDaysinteger[ 1 .. 99 ]

Specifies the number of days the direct debit instruction must be tracked.

{
  "dateOfSignature": "2019-08-24",
  "electronicSignature": "string",
  "finalCollectionDate": "2019-08-24",
  "firstCollectionDate": "2019-08-24",
  "frequency": {
    "dayOfMonth": 1,
    "schema": "MonthlyFrequency"
  },
  "mandateIdentification": "string",
  "reason": {
    "schema": "string",
    "value": "stri"
  },
  "trackingDays": 1
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations