EPC API for receiving Electrum calls (17.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

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-partner-redoc/

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

ChargeBearer

DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme

string(ChargeBearer)

DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme

Enum"DEBT""CRED""SHAR""SLEV"

"DEBT"

ChargeTypeCode

schemastringrequired

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

valuestringrequired

BRKF (BrokerageFee): Fee paid to a broker for services provided.
BTCH (Batch): Fee paid for processing a batch of transactions.
COMM (Commission): Fee paid for services provided.
SUMM (Summation): Summation of individual fees.
AMND (Amendment): Payment order was changed based on request to do so from the (original) sending bank or as a result of receiving amended information from the (original) sending bank.
CFEE (CancellationFee): Used when fees are assessed for cancellation of a payment.
CLEF (ClearingFee): Used when fees are assessed for standard processing of financial institution type transfers.
INVS (Investigation): Charges related to the processing of an investigation case/inquiry.
INTE (Interest): Interest related charges.
NSTP (NonSTPCharges): Charge for a payment that required an intervention during processing.
DEBT (BorneByDebtor): Claim is being submitted in response to receiving a customer credit transfer with DEBT in Charge Bearer code.
TELE (TelecommunicationCharges): Charges relating to the most appropriate and efficient means of telecommunications available, for example, SWIFT, telex, telephone, facsimile, as determined by the party executing the payment instruction.
ACCM (AccMaintenanceFee): Account maintenance fee.
RECH (ReportingCharges): Charge for a reporting message (camt.05X).

Enum"BRKF""BTCH""COMM""SUMM""AMND""CFEE""CLEF""INVS""INTE""NSTP"

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

ChargeType

schemastringrequired

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

Discriminator

valuestringrequired

BRKF (BrokerageFee): Fee paid to a broker for services provided.
BTCH (Batch): Fee paid for processing a batch of transactions.
COMM (Commission): Fee paid for services provided.
SUMM (Summation): Summation of individual fees.
AMND (Amendment): Payment order was changed based on request to do so from the (original) sending bank or as a result of receiving amended information from the (original) sending bank.
CFEE (CancellationFee): Used when fees are assessed for cancellation of a payment.
CLEF (ClearingFee): Used when fees are assessed for standard processing of financial institution type transfers.
INVS (Investigation): Charges related to the processing of an investigation case/inquiry.
INTE (Interest): Interest related charges.
NSTP (NonSTPCharges): Charge for a payment that required an intervention during processing.
DEBT (BorneByDebtor): Claim is being submitted in response to receiving a customer credit transfer with DEBT in Charge Bearer code.
TELE (TelecommunicationCharges): Charges relating to the most appropriate and efficient means of telecommunications available, for example, SWIFT, telex, telephone, facsimile, as determined by the party executing the payment instruction.
ACCM (AccMaintenanceFee): Account maintenance fee.
RECH (ReportingCharges): Charge for a reporting message (camt.05X).

Enum"BRKF""BTCH""COMM""SUMM""AMND""CFEE""CLEF""INVS""INTE""NSTP"

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

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations