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

ServiceLevelCode

schemastringrequired

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

valuestring(ExternalServiceLevel1Code)required

BKTR (BookTransaction): Payment through internal book transfer.
G001 (TrackedCustomerCreditTransfer): Tracked Customer Credit Transfer.
G002 (TrackedStopAndRecall): Tracked Stop and Recall
G003 (TrackedOutboundCorporateTransfer): Tracked Outbound Corporate Transfer.
G004 (TrackedFinancialInstitutionTransfer): Tracked Financial Institution Transfer.
NPCA (NordicPaymentsCouncilAreaTransfer): Payments must be executed following the NPC Area Payment scheme.
NUGP (NonurgentPriorityPayment): Payment must be executed as a non-urgent transaction with priority settlement.
NURG (NonurgentPayment): Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.
PRPT (EBAPriorityService): Transaction must be processed according to the EBA Priority Service.
SDVA (SameDayValue): Payment must be executed with same day value to the creditor.
SEPA (SingleEuroPaymentsArea): Payment must be executed following the Single Euro Payments Area scheme.
SVDE (DomesticChequeClearingAndSettlement): Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland.
URGP (UrgentPayment): Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.
URNS (UrgentPaymentNetSettlement): Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.
INST (InstantCreditTransferOrInstantDirectDebit): Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.
SRTP (ServiceRequestToPay): Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).
SVAT (ScheckVerarbeitungAustria): Scheck Verarbeitung Austria (Cheque Processing).
G006 (TrackedCaseManagement): Specifies the service conditions applicable to a tracked exceptions and investigations case.
G007 (TrackedInboundCustomerCreditTransfer): Specifies the service level for a tracked inbound customer credit transfer.
G005 (TrackedInstantCustomerCreditTransfer): Tracked Instant Customer Credit Transfer.
G009 (TrackedLowValueCrossBorderCustomerCreditTransfer): Specifies the service level for a tracked low-value cross-border customer credit transfer.
WFSM (WaitForSettlement): Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.
EOLO (EuroOneLegOut): Payment is executed following a Euro One-Leg Out Scheme.
SPLI (SplitPayment): A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.

Enum"BKTR""G001""G002""G003""G004""NPCA""NUGP""NURG""PRPT""SDVA"

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

ServiceLevel

schemastringrequired

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

Discriminator

valuestring(ExternalServiceLevel1Code)required

BKTR (BookTransaction): Payment through internal book transfer.
G001 (TrackedCustomerCreditTransfer): Tracked Customer Credit Transfer.
G002 (TrackedStopAndRecall): Tracked Stop and Recall
G003 (TrackedOutboundCorporateTransfer): Tracked Outbound Corporate Transfer.
G004 (TrackedFinancialInstitutionTransfer): Tracked Financial Institution Transfer.
NPCA (NordicPaymentsCouncilAreaTransfer): Payments must be executed following the NPC Area Payment scheme.
NUGP (NonurgentPriorityPayment): Payment must be executed as a non-urgent transaction with priority settlement.
NURG (NonurgentPayment): Payment must be executed as a non-urgent transaction, which is typically identified as an ACH or low value transaction.
PRPT (EBAPriorityService): Transaction must be processed according to the EBA Priority Service.
SDVA (SameDayValue): Payment must be executed with same day value to the creditor.
SEPA (SingleEuroPaymentsArea): Payment must be executed following the Single Euro Payments Area scheme.
SVDE (DomesticChequeClearingAndSettlement): Payment execution following the cheque agreement and traveller cheque agreement of the German Banking Industry Committee (Die Deutsche Kreditwirtschaft - DK) and Deutsche Bundesbank – Scheck Verrechnung Deutschland.
URGP (UrgentPayment): Payment must be executed as an urgent transaction cleared through a real-time gross settlement system, which is typically identified as a wire or high value transaction.
URNS (UrgentPaymentNetSettlement): Payment must be executed as an urgent transaction cleared through a real-time net settlement system, which is typically identified as a wire or high value transaction.
INST (InstantCreditTransferOrInstantDirectDebit): Used for payment initiation to identify that a Payment or Direct Debit initiation must be executed as an instant or real-time payment instrument.
SRTP (ServiceRequestToPay): Request to Pay (RTP) transaction refers to an RTP scheme (such as for example the SEPA Request to Pay (SRTP) scheme).
SVAT (ScheckVerarbeitungAustria): Scheck Verarbeitung Austria (Cheque Processing).
G006 (TrackedCaseManagement): Specifies the service conditions applicable to a tracked exceptions and investigations case.
G007 (TrackedInboundCustomerCreditTransfer): Specifies the service level for a tracked inbound customer credit transfer.
G005 (TrackedInstantCustomerCreditTransfer): Tracked Instant Customer Credit Transfer.
G009 (TrackedLowValueCrossBorderCustomerCreditTransfer): Specifies the service level for a tracked low-value cross-border customer credit transfer.
WFSM (WaitForSettlement): Transaction is to be treated as an advice and only applied to the account of the creditor or next agent after settlement of the cover has been confirmed.
EOLO (EuroOneLegOut): Payment is executed following a Euro One-Leg Out Scheme.
SPLI (SplitPayment): A split payment is a payment that is split into several payments of lower value, namely with the purpose to comply with maximum amount thresholds applicable to some domestic Payment Market Infrastructures or to reduce counterparty liquidity risk.

Enum"BKTR""G001""G002""G003""G004""NPCA""NUGP""NURG""PRPT""SDVA"

{
  "schema": "CODE",
  "value": "BKTR"
}

PaymentTypeInformation

categoryPurposeobject(CategoryPurpose)

localInstrumentobject(LocalInstrumentType)

serviceLevelArray of objects(ServiceLevel)

{
  "categoryPurpose": {
    "schema": "string",
    "value": "BONU"
  },
  "localInstrument": {
    "schema": "string",
    "value": "0000"
  },
  "serviceLevel": [
    { … }
  ]
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations