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

IdentifierDeterminationReport

schemastring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

Discriminator

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

instructionForCreatorAgentArray of objects(CreditorAgentInstruction)>= 0 items

Further information related to the proxy resolution response, provided by the Operator, and intended for the creator agent.

originalRequestorobject(ZaRppRequestor)

originalUetrstring(UUID)required

The universally unique identifier provided in the original request as an end-to-end reference. This identifier remains the same for all messages related to the same transaction.

originalVerificationIdentificationstring[ 1 .. 35 ] charactersrequired

The request.verificationIdentification as provided in the original request.

reportInformationobject(ZaRppIdentificationReport)required

A report providing information from the lookup of a proxy in the context of the ZA RPP Payment Scheme.

This report returns information required to proceed with the clearing of funds through the use of the proxy (identifier) provided in the identifier determination request. Specifically, this report will provide the outcome of the lookup of said identifier, indication whether it is valid or not, as well as provide the name ("known as name") of the creditor, and the legal name of the creditor (both of these are mandatory in the ZA RPP Payment Scheme, despite not being mandatory in this API), namely:

accountOwner.knownAsName
accountOwner.legalName

reportInformation.accountAgentobject(InstitutionIdentification)

reportInformation.accountInformationobject(ZaRppAccountInformation)

reportInformation.accountOwnerobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

reportInformation.outcomestringrequired

Enum"SUCCESSFUL""FAILED"

reportInformation.reasonCodestring[ 1 .. 4 ] characters

AB06 : Transaction stopped due to timeout at the Instructed Agent.
AB07 : Agent of message is not online. Generic usage if it cannot be determined who exactly is not online.
AB10 : An error occured at the instructed agent
AC06 : Account specified is blocked, prohibiting posting of transactions against it
AG01 : Transaction forbidden on this type of account
AG03 : Transaction type not supported/authorized on this account.
AG10 : Agent of message is suspended from the Real Time Payment system. Generic usage if it cannot be determined who exactly is suspended.
AGNT : Agent in the payment workflow is incorrect
AM02 : Specific transaction/message amount is greater than allowed maximum (e.g. payee proxy participant service limit exceeded
CH21 : Mandatory element is missing .
DT02 : Invalid creation date and time in Group Header (eg, historic date) .
DU03 : Transaction is not unique.
DUPL : Request is a duplicate of another request
FF02 : Syntax error reason is provided as narrative information in the additional reason information.
FF08 : End to End Id missing or invalid .
NAUT : Permission to be processed is not granted
NOOR : Original SCT never received
PD01 : Domain not found or invalid
PD02 : Suspended Domain provided is suspended pending investigation
BE23 : Phone number or email address, or any other proxy, used as the account proxy is unknown or invalid.
PX03 : Proxy not found in central repository
PX04 : Format of proxy invalid
RC05 : BIC identifier is invalid or missing.
RC08 : ClearingSystemMemberidentifier is invalid or missing. Generic usage if cannot specify between debit or credit account .
RR10 : Character set supplied not valid for the country and payment type.
RR12 : Invalid or missing identification required within a particular country or payment type.
RF01 : Transaction reference is not unique within the message.
AC16 : Account in Sequestration
AC17 : Account in Liquidation
AC04 : Account Closed
AC01 : Format of the account number specified is not correct
MD07 : Account Holder Deceased
NOCM : Customer account is not compliant with regulatory requirements, for example FICA (in South Africa) or any other regulatory requirements which render an account inactive for certain processing.
BE01 : Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency).

reportInformation.transactionLimitobject(Amount)

{
  "schema": "ZA_RPP",
  "instructedAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "instructingAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "instructionForCreatorAgent": [
    { … }
  ],
  "originalRequestor": {
    "schema": "string"
  },
  "originalUetr": "string",
  "originalVerificationIdentification": "string",
  "reportInformation": {
    "accountAgent": { … },
    "accountInformation": { … },
    "accountOwner": { … },
    "outcome": "SUCCESSFUL",
    "reasonCode": "stri",
    "transactionLimit": { … }
  }
}

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"

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations