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

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

ExternalCashAccountType1Code

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

string(ExternalCashAccountType1Code)

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

"CACC"

AccountTypeCode

schemastringrequired

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

valuestring(ExternalCashAccountType1Code)required

CACC : Current - Account used to post debits and credits when no specific account has been nominated.
CARD : Card Account - Account used for credit card payments.
CASH : Cash Payment - Account used for the payment of cash.
CHAR : Charges - Account used for charges if different from the account for payment.
CISH : Cash Income - Account used for payment of income if different from the current cash account.
COMM : Commission - Account used for commission if different from the account for payment.
CPAC : Clearing Participant Settlement Account - Account used to post settlement debit and credit entries on behalf of a designated Clearing Participant.
LLSV : Limited Liquidity Savings Account - Account used for savings with special interest and withdrawal terms.
LOAN : Loan - Account used for loans.
MGLD : Marginal Lending - Account used for a marginal lending facility.
MOMA : Money Market - Account used for money markets if different from the cash account.
NREX : Non-Resident External - Account used for non-resident external.
ODFT : Overdraft - Account is used for overdrafts.
ONDP : Overnight Deposit - Account used for overnight deposits.
OTHR : Other Account - Account not otherwise specified.
SACC : Settlement - Account used to post debit and credit entries, as a result of transactions cleared and settled through a specific clearing and settlement system.
SLRY : Salary - Accounts used for salary payments.
SVGS : Savings - Account used for savings.
TAXE : Tax - Account used for taxes if different from the account for payment.
TRAN : Transacting Account - A transacting account is the most basic type of bank account that you can get. The main difference between transaction and cheque accounts is that you usually do not get a cheque book with your transacting account and neither are you offered an overdraft facility.
TRAS : Cash Trading - Account used for trading if different from the current cash account.

Enum"CACC""CARD""CASH""CHAR""CISH""COMM""CPAC""LLSV""LOAN""MGLD"

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

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations