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

Languages
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

PaymentMethod

  • CreditTransfer - Transfer of an amount of money in the books of the account servicer.
  • DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.
string(PaymentMethod)
  • CreditTransfer - Transfer of an amount of money in the books of the account servicer.
  • DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.
Enum"CreditTransfer""DirectDebit"
"CreditTransfer"

ExternalCategoryPurpose1Code

  • BONU (BonusPayment): Transaction is the payment of a bonus.
  • CASH (CashManagementTransfer): Transaction is a general cash management instruction.
  • CBLK (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
  • CCRD (CreditCardPayment): Transaction is related to a payment of credit card.
  • CORT (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
  • DCRD (DebitCardPayment): Transaction is related to a payment of debit card.
  • DIVI (Dividend): Transaction is the payment of dividends.
  • DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
  • EPAY (Epayment): Transaction is related to ePayment.
  • FCIN (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.
  • FCOL (FeeCollection): A service that is settling card transaction related fees between two parties.
  • GP2P (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.
  • GOVT (GovernmentPayment): Transaction is a payment to or from a government department.
  • HEDG (Hedging): Transaction is related to the payment of a hedging operation.
  • ICCP (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.
  • IDCP (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.
  • INTC (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
  • INTE (Interest): Transaction is the payment of interest.
  • LBOX (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
  • LOAN (Loan): Transaction is related to the transfer of a loan to a borrower.
  • MP2B (Commercial): Mobile P2B Payment
  • MP2P (Consumer): Mobile P2P Payment
  • OTHR (OtherPayment): Other payment purpose.
  • PENS (PensionPayment): Transaction is the payment of pension.
  • RPRE (Represented): Collection used to re-present previously reversed or returned direct debit transactions.
  • RRCT (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
  • RVPM (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
  • SALA (SalaryPayment): Transaction is the payment of salaries.
  • SECU (Securities): Transaction is the payment of securities.
  • SSBE (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.
  • SUPP (SupplierPayment): Transaction is related to a payment to a supplier.
  • TAXS (TaxPayment): Transaction is the payment of taxes.
  • TRAD (Trade): Transaction is related to the payment of a trade finance transaction.
  • TREA (TreasuryPayment): Transaction is related to treasury operations. E.g. financial contract settlement.
  • VATX (ValueAddedTaxPayment): Transaction is the payment of value added tax.
  • WHLD (WithHolding): Transaction is the payment of withholding tax.
  • SWEP (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.
  • TOPG (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.
  • ZABA (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.
  • VOST (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.
  • FCDT (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.
  • CIPC (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.
  • CONC (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.
  • CGWV (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.
  • SAVG (Savings): Transfer to / from savings or to retirement account.
  • CTDF (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.
string(ExternalCategoryPurpose1Code)
  • BONU (BonusPayment): Transaction is the payment of a bonus.
  • CASH (CashManagementTransfer): Transaction is a general cash management instruction.
  • CBLK (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
  • CCRD (CreditCardPayment): Transaction is related to a payment of credit card.
  • CORT (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
  • DCRD (DebitCardPayment): Transaction is related to a payment of debit card.
  • DIVI (Dividend): Transaction is the payment of dividends.
  • DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
  • EPAY (Epayment): Transaction is related to ePayment.
  • FCIN (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.
  • FCOL (FeeCollection): A service that is settling card transaction related fees between two parties.
  • GP2P (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.
  • GOVT (GovernmentPayment): Transaction is a payment to or from a government department.
  • HEDG (Hedging): Transaction is related to the payment of a hedging operation.
  • ICCP (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.
  • IDCP (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.
  • INTC (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
  • INTE (Interest): Transaction is the payment of interest.
  • LBOX (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
  • LOAN (Loan): Transaction is related to the transfer of a loan to a borrower.
  • MP2B (Commercial): Mobile P2B Payment
  • MP2P (Consumer): Mobile P2P Payment
  • OTHR (OtherPayment): Other payment purpose.
  • PENS (PensionPayment): Transaction is the payment of pension.
  • RPRE (Represented): Collection used to re-present previously reversed or returned direct debit transactions.
  • RRCT (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
  • RVPM (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
  • SALA (SalaryPayment): Transaction is the payment of salaries.
  • SECU (Securities): Transaction is the payment of securities.
  • SSBE (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.
  • SUPP (SupplierPayment): Transaction is related to a payment to a supplier.
  • TAXS (TaxPayment): Transaction is the payment of taxes.
  • TRAD (Trade): Transaction is related to the payment of a trade finance transaction.
  • TREA (TreasuryPayment): Transaction is related to treasury operations. E.g. financial contract settlement.
  • VATX (ValueAddedTaxPayment): Transaction is the payment of value added tax.
  • WHLD (WithHolding): Transaction is the payment of withholding tax.
  • SWEP (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.
  • TOPG (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.
  • ZABA (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.
  • VOST (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.
  • FCDT (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.
  • CIPC (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.
  • CONC (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.
  • CGWV (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.
  • SAVG (Savings): Transfer to / from savings or to retirement account.
  • CTDF (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.
Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"
"BONU"

CategoryPurposeCode

schemastringrequired

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

valuestring(ExternalCategoryPurpose1Code)required
  • BONU (BonusPayment): Transaction is the payment of a bonus.
  • CASH (CashManagementTransfer): Transaction is a general cash management instruction.
  • CBLK (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
  • CCRD (CreditCardPayment): Transaction is related to a payment of credit card.
  • CORT (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
  • DCRD (DebitCardPayment): Transaction is related to a payment of debit card.
  • DIVI (Dividend): Transaction is the payment of dividends.
  • DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
  • EPAY (Epayment): Transaction is related to ePayment.
  • FCIN (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.
  • FCOL (FeeCollection): A service that is settling card transaction related fees between two parties.
  • GP2P (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.
  • GOVT (GovernmentPayment): Transaction is a payment to or from a government department.
  • HEDG (Hedging): Transaction is related to the payment of a hedging operation.
  • ICCP (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.
  • IDCP (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.
  • INTC (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
  • INTE (Interest): Transaction is the payment of interest.
  • LBOX (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
  • LOAN (Loan): Transaction is related to the transfer of a loan to a borrower.
  • MP2B (Commercial): Mobile P2B Payment
  • MP2P (Consumer): Mobile P2P Payment
  • OTHR (OtherPayment): Other payment purpose.
  • PENS (PensionPayment): Transaction is the payment of pension.
  • RPRE (Represented): Collection used to re-present previously reversed or returned direct debit transactions.
  • RRCT (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
  • RVPM (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
  • SALA (SalaryPayment): Transaction is the payment of salaries.
  • SECU (Securities): Transaction is the payment of securities.
  • SSBE (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.
  • SUPP (SupplierPayment): Transaction is related to a payment to a supplier.
  • TAXS (TaxPayment): Transaction is the payment of taxes.
  • TRAD (Trade): Transaction is related to the payment of a trade finance transaction.
  • TREA (TreasuryPayment): Transaction is related to treasury operations. E.g. financial contract settlement.
  • VATX (ValueAddedTaxPayment): Transaction is the payment of value added tax.
  • WHLD (WithHolding): Transaction is the payment of withholding tax.
  • SWEP (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.
  • TOPG (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.
  • ZABA (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.
  • VOST (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.
  • FCDT (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.
  • CIPC (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.
  • CONC (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.
  • CGWV (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.
  • SAVG (Savings): Transfer to / from savings or to retirement account.
  • CTDF (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.
Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"
{
  "schema": "string",
  "value": "BONU"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd