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

PurposeType

Specifies the underlying reason for the payment transaction

schemastringrequired

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

Discriminator
valuestringrequired
  • ACCT : AccountManagement
  • ADCS : AdvisoryDonationCopyrightServices
  • ADMG : AdministrativeManagement
  • ADVA : AdvancePayment
  • AEMP : ActiveEmploymentPolicy
  • AGRT : AgriculturalTransfer
  • AIRB : Air
  • ALLW : Allowance
  • ALMY : AlimonyPayment
  • AMEX : Amex
  • ANNI : Annuity
  • ANTS : AnesthesiaServices
  • AREN : AccountsReceivablesEntry
  • AUCO : AuthenticatedCollections
  • B112 : TrailerFeePayment
  • BBSC : BabyBonusScheme
  • BCDM : BearerChequeDomestic
  • BCFG : BearerChequeForeign
  • BECH : ChildBenefit
  • BENE : UnemploymentDisabilityBenefit
  • BEXP : BusinessExpenses
  • BFWD : BondForward
  • BKDF : BankLoanDelayedDrawFunding
  • BKFE : BankLoanFees
  • BKFM : BankLoanFundingMemo
  • BKIP : BankLoanAccruedInterestPayment
  • BKPP : BankLoanPrincipalPaydown
  • BLDM : BuildingMaintenance
  • BNET : BondForwardNetting
  • BOCE : BackOfficeConversionEntry
  • BOND : Bonds
  • BONU : BonusPayment.
  • BR12 : TrailerFeeRebate
  • BUSB : Bus
  • CABD : CorporateActions-Bonds
  • CAEQ : CorporateActions-Equities
  • CAFI : CustodianManagementFeeInhouse
  • CASH : CashManagementTransfer
  • CBCR : CreditCard
  • CBFF : CapitalBuilding
  • CBFR : CapitalBuildingRetirement
  • CBLK : CardBulkClearing
  • CBTV : CableTVBill
  • CCHD : CashCompensationHelplessnessDisability
  • CCIR : CrossCurrencyIRS
  • CCPC : CCPClearedInitialMargin
  • CCPM : CCPClearedVariationMargin
  • CCRD : CreditCardPayment
  • CCSM : CCPClearedInitialMarginSegregatedCash
  • CDBL : CreditCardBill
  • CDCB : CardPaymentWithCashBack
  • CDCD : CashDisbursementCashSettlement
  • CDCS : CashDisbursementWithSurcharging
  • CDDP : CardDeferredPayment
  • CDEP : CreditDefaultEventPayment
  • CDOC : OriginalCredit
  • CDQC : QuasiCash
  • CFDI : CapitalFallingDueInhouse
  • CFEE : CancellationFee
  • CGDD : CardGeneratedDirectDebit
  • CHAR : CharityPayment
  • CLPR : CarLoanPrincipalRepayment
  • CMDT : CommodityTransfer
  • COLL : CollectionPayment
  • COMC : CommercialPayment
  • COMM : Commission
  • COMP : CompensationPayment
  • COMT : ConsumerThirdPartyConsolidatedPayment
  • CORT : TradeSettlementPayment
  • COST : Costs
  • CPKC : CarparkCharges
  • CPYR : Copyright
  • CRDS : CreditDefaultSwap
  • CRPR : CrossProduct
  • CRSP : CreditSupport
  • CRTL : CreditLine
  • CSDB : CashDisbursementCashManagement
  • CSLP : CompanySocialLoanPaymentToBank
  • CVCF : ConvalescentCareFacility
  • DBCR : DebitCard
  • DBTC : DebitCollectionPayment
  • DCRD : DebitCardPayment
  • DEPT : Deposit
  • DERI : Derivatives
  • DICL : Diners
  • DIVD : Dividend
  • DMEQ : DurableMedicaleEquipment
  • DNTS : DentalServices
  • DSMT : PrintedOrderDisbursement
  • DVPM : DeliverAgainstPayment
  • ECPG : GuaranteedEPayment
  • ECPR : EPaymentReturn
  • ECPU : NonGuaranteedEPayment
  • EDUC : Education
  • EFTC : LowValueCredit
  • EFTD : LowValueDebit
  • ELEC : ElectricityBill
  • ENRG : Energies
  • EPAY : Epayment
  • EQPT : EquityOption
  • EQTS : Equities
  • EQUS : EquitySwap
  • ESTX : EstateTax
  • ETUP : EPurseTopUp
  • EXPT : ExoticOption
  • EXTD : ExchangeTradedDerivatives
  • FACT : FactorUpdateRelatedPayment
  • FAND : FinancialAidInCaseOfNaturalDisaster
  • FCOL : FeeCollection
  • FCPM : LatePaymentOfFeesAndCharges
  • FEES : PaymentOfFees
  • FERB : Ferry
  • FIXI : FixedIncome
  • FLCR : FleetCard
  • FNET : FuturesNettingPayment
  • FORW : ForwardForeignExchange
  • FREX : ForeignExchange
  • FUTR : Futures
  • FWBC : ForwardBrokerOwnedCashCollateral
  • FWCC : ForwardClientOwnedCashCollateral
  • FWLV : ForeignWorkerLevy
  • FWSB : ForwardBrokerOwnedCashCollateralSegregated
  • FWSC : ForwardClientOwnedSegregatedCashCollateral
  • FXNT : ForeignExchangeRelatedNetting
  • GAFA : GovernmentFamilyAllowance
  • GAHO : GovernmentHousingAllowance
  • GAMB : GamblingOrWageringPayment
  • GASB : GasBill
  • GDDS : PurchaseSaleOfGoods
  • GDSV : PurchaseSaleOfGoodsAndServices
  • GFRP : GuaranteeFundRightsPayment
  • GIFT : Gift
  • GOVI : GovernmentInsurance
  • GOVT : GovernmentPayment
  • GSCB : PurchaseSaleOfGoodsAndServicesWithCashBack
  • GSTX : GoodsServicesTax
  • GVEA : AustrianGovernmentEmployeesCategoryA
  • GVEB : AustrianGovernmentEmployeesCategoryB
  • GVEC : AustrianGovernmentEmployeesCategoryC
  • GVED : AustrianGovernmentEmployeesCategoryD
  • GWLT : GovermentWarLegislationTransfer
  • HEDG : Hedging
  • HLRP : PropertyLoanRepayment
  • HLST : PropertyLoanSettlement
  • HLTC : HomeHealthCare
  • HLTI : HealthInsurance
  • HREC : HousingRelatedContribution
  • HSPC : HospitalCare
  • HSTX : HousingTax
  • ICCP : IrrevocableCreditCardPayment
  • ICRF : IntermediateCareFacility
  • IDCP : IrrevocableDebitCardPayment
  • IHRP : InstalmentHirePurchaseAgreement
  • INPC : InsurancePremiumCar
  • INPR : InsurancePremiumRefund
  • INSC : PaymentOfInsuranceClaim
  • INSM : Installment
  • INSU : InsurancePremium
  • INTC : IntraCompanyPayment
  • INTE : Interest
  • INTP : IntraPartyPayment
  • INTX : IncomeTax
  • INVS : InvestmentAndSecurities
  • IPAY : InstantPayments
  • IPCA : InstantPaymentsCancellation
  • IPDO : InstantPaymentsForDonations
  • IPEA : InstantPaymentsInECommerceWithoutAddressData
  • IPEC : InstantPaymentsInECommerceWithAddressData
  • IPEW : InstantPaymentsInECommerce
  • IPPS : InstantPaymentsAtPOS
  • IPRT : InstantPaymentsReturn
  • IPU2 : InstantPaymentsUnattendedVendingMachineWith2FA
  • IPUW : InstantPaymentsUnattendedVendingMachineWithout2FA
  • IVPT : InvoicePayment
  • LBIN : LendingBuyInNetting
  • LBRI : LaborInsurance
  • LCOL : LendingCashCollateralFreeMovement
  • LFEE : LendingFees
  • LICF : LicenseFee
  • LIFI : LifeInsurance
  • LIMA : LiquidityManagement
  • LMEQ : LendingEquityMarkedToMarketCashCollateral
  • LMFI : LendingFixedIncomeMarkedToMarketCashCollateral
  • LMRK : LendingUnspecifiedTypeOfMarkedToMarketCashCollateral
  • LOAN : Loan
  • LOAR : LoanRepayment
  • LOTT : LotteryPayment
  • LREB : LendingRebatePayments
  • LREV : LendingRevenuePayments
  • LSFL : LendingClaimPayment
  • LTCF : LongTermCareFacility
  • MAFC : MedicalAidFundContribution
  • MARF : MedicalAidRefund
  • MARG : DailyMarginOnListedDerivatives
  • MBSB : MBSBrokerOwnedCashCollateral
  • MBSC : MBSClientOwnedCashCollateral
  • MCDM : MultiCurrenyChequeDomestic
  • MCFG : MultiCurrenyChequeForeign
  • MDCS : MedicalServices
  • MGCC : FuturesInitialMargin
  • MGSC : FuturesInitialMarginClientOwnedSegregatedCashCollateral
  • MOMA : MoneyMarket
  • MP2B : MobileP2BPayment
  • MP2P : MobileP2PPayment
  • MSVC : MultipleServiceTypes
  • MTUP : MobileTopUp
  • NETT : Netting
  • NITX : NetIncomeTax
  • NOWS : NotOtherwiseSpecified
  • NWCH : NetworkCharge
  • NWCM : NetworkCommunication
  • OCCC : ClientOwnedOCCPledgedCollateral
  • OCDM : OrderChequeDomestic
  • OCFG : OrderChequeForeign
  • OFEE : OpeningFee
  • OPBC : OTCOptionBrokerOwnedCashCollateral
  • OPCC : OTCOptionClientOwnedCashCollateral
  • OPSB : OTCOptionBrokerOwnedSegregatedCashCollateral
  • OPSC : OTCOptionClientOwnedCashSegregatedCashCollateral
  • OPTN : FXOption
  • OTCD : OTCDerivatives
  • OTHR : Other
  • OTLC : OtherTelecomRelatedBill
  • PADD : PreauthorizedDebit
  • PAYR : Payroll
  • PCOM : PropertyCompletionPayment
  • PDEP : PropertyDeposit
  • PEFC : PensionFundContribution
  • PENO : PaymentBasedOnEnforcementOrder
  • PENS : PensionPayment
  • PHON : TelephoneBill
  • PLDS : PropertyLoanDisbursement
  • PLRF : PropertyLoanRefinancing
  • POPE : PointOfPurchaseEntry
  • PPTI : PropertyInsurance
  • PRCP : PricePayment
  • PRME : PreciousMetal
  • PTSP : PaymentTerms
  • PTXP : PropertyTax
  • RAPI : RapidPaymentInstruction
  • RCKE : RepresentedCheckEntry
  • RCPT : ReceiptPayment
  • RDTX : RoadTax
  • REBT : Rebate
  • REFU : Refund
  • RELG : RentalLeaseGeneral
  • RENT : Rent
  • REOD : AccountOverdraftRepayment
  • REPO : RepurchaseAgreement
  • RHBS : RehabilitationSupport
  • RIMB : ReimbursementOfAPreviousErroneousTransaction
  • RINP : RecurringInstallmentPayment
  • RLWY : Railway
  • ROYA : Royalties
  • RPBC : BilateralRepoBrokerOwnedCollateral
  • RPCC : RepoClientOwnedCollateral
  • RPNT : BilateralRepoInternetNetting
  • RPSB : BilateralRepoBrokerOwnedSegregatedCashCollateral
  • RPSC : BilateralRepoClientOwnedSegregatedCashCollateral
  • RRBN : RoundRobin
  • RRCT : ReimbursementReceivedCreditTransfer
  • RRTP : RelatedRequestToPay
  • RVPM : ReceiveAgainstPayment
  • RVPO : ReverseRepurchaseAgreement
  • SALA : SalaryPayment
  • SASW : ATM
  • SAVG : Savings
  • SBSC : SecuritiesBuySellSellBuyBack
  • SCIE : SingleCurrencyIRSExotic
  • SCIR : SingleCurrencyIRS
  • SCRP : SecuritiesCrossProducts
  • SCVE : PurchaseSaleOfServices
  • SECU : Securities
  • SEPI : SecuritiesPurchaseInhouse
  • SERV : ServiceCharges
  • SHBC : BrokerOwnedCollateralShortSale
  • SHCC : ClientOwnedCollateralShortSale
  • SHSL : ShortSell
  • SLEB : SecuritiesLendingAndBorrowing
  • SLOA : SecuredLoan
  • SLPI : PaymentSlipInstruction
  • SPLT : SplitPayments
  • SPSP : SalaryPensionSumPayment
  • SSBE : SocialSecurityBenefit
  • STDY : Study
  • SUBS : Subscription
  • SUPP : SupplierPayment
  • SWBC : SwapBrokerOwnedCashCollateral
  • SWCC : SwapClientOwnedCashCollateral
  • SWFP : SwapContractFinalPayment
  • SWPP : SwapContractPartialPayment
  • SWPT : Swaption
  • SWRS : SwapContractResetPayment
  • SWSB : SwapsBrokerOwnedSegregatedCashCollateral
  • SWSC : SwapsClientOwnedSegregatedCashCollateral
  • SWUF : SwapContractUpfrontPayment
  • TAXR : TaxRefund
  • TAXS : TaxPayment
  • TBAN : TBAPairOffNetting
  • TBAS : ToBeAnnounced
  • TBBC : TBABrokerOwnedCashCollateral
  • TBCC : TBAClientOwnedCashCollateral
  • TBIL : TelecommunicationsBill
  • TCSC : TownCouncilServiceCharges
  • TELI : TelephoneInitiatedTransaction
  • TLRF : NonUSMutualFundTrailerFeePayment
  • TLRR : NonUSMutualFundTrailerFeeRebatePayment
  • TMPG : TMPGClaimPayment
  • TPRI : TriPartyRepoInterest
  • TPRP : TriPartyRepoNetting
  • TRAD : Commercial
  • TRCP : TreasuryCrossProduct
  • TREA : TreasuryPayment
  • TRFD : TrustFund
  • TRNC : TruncatedPaymentSlip
  • TRPT : RoadPricing
  • TRVC : TravellerCheque
  • UBIL : Utilities
  • UNIT : UnitTrustPurchase
  • VATX : ValueAddedTaxPayment
  • VIEW : VisionCare
  • WEBI : InternetInitiatedTransaction
  • WHLD : WithHolding
  • WTER : WaterBill
Enum"BKDF""BKFE""BKFM""BKIP""BKPP""CBLK""CDCB""CDCD""CDCS""CDDP"
{
  "schema": "CODE",
  "value": "BKDF"
}

RequestToPayConditions

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

maxAmountobject(Amount)required
maxAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

maxAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
minAmountobject(Amount)required
minAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

minAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
{
  "maxAmount": {
    "currency": "string",
    "value": 0.1
  },
  "minAmount": {
    "currency": "string",
    "value": 0.1
  }
}

TaxInformation

totalAmountobject(Amount)required
totalAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

totalAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0✓Represents 10 USD and no cents.
USD10.00✓
USD10.001✗US dollar does not support three decimal places.
JPY10.0✓Represents 10 Japanese Yen.
JPY10.1✗Japanese Yen does not support decimal places.
{
  "totalAmount": {
    "currency": "string",
    "value": 0.1
  }
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd