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

Mock server

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

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

CreditorAgentInstruction

Further information related to the processing of the payment instruction that may need to be acted upon by the creditor's agent. The instruction may relate to a level of service, or may be an instruction that has to be executed by the creditor's agent, or may be information required by the creditor's agent

codestring

CHQB: (PayCreditorByCheque) (Ultimate) creditor must be paid by cheque.
HOLD: (HoldCashForCreditor) Amount of money must be held for the (ultimate) creditor, who will call. Pay on identification.
PHOB: (PhoneBeneficiary) Please advise/contact (ultimate) creditor/claimant by phone.
PRTK: (PayerTokenRequested) Indicates that a payer token is requested/used.
RECI: (ReceiverCustomerInformation) Further information regarding the intended recipient.
TELB: (Telecom) Please advise/contact (ultimate) creditor/claimant by the most efficient means of telecommunication.
TKCM: (TokenCounterpartyMismatch) Token found with counterparty mismatch.
TKSG: (TokenSingleUse) Single Use Token already used.
TKSP: (TokenSuspended) Token found with suspended status.
TKVE: (TokenValueLimitExceeded) Token found with value limit rule violation.
TKXP: (TokenExpired) Token expired.
TOKN: (Token) Token information.
VLTK: (TokenValidation) Additional validation information to be used in conjunction with the token.
SEID: (SecondaryIdentification): Use of Secondary Identification of Creditor Account (which may relate to Head Office Collection Account, Building Society Roll Number or Credit Card Primary Account Number).
RT14: A ZA-RPP scheme-specific instruction regarding fraud scores.

Enum"CHQB""HOLD""PHOB""PRTK""RECI""TELB""TKCM""TKSG""TKSP""TKVE"

informationstring[ 1 .. 140 ] characters

Further information complementing the coded instruction or instruction to the next agent that is bilaterally agreed or specific to a user community.

{
  "code": "CHQB",
  "information": "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

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

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations