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

Languages
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

ReferredDocumentType

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"
Discriminator
valuestringrequired
  • AROI : AccountReceivableOpenItem
  • BOLD : BillOfLading
  • CINV : CommercialInvoice
  • CMCN : CommercialContract
  • CNFA : CreditNoteRelatedToFinancialAdjustment
  • CREN : CreditNote
  • DEBN : DebitNote
  • DISP : DispatchAdvice
  • DNFA : DebitNoteRelatedToFinancialAdjustment
  • HIRI : HireInvoice
  • MSIN : MeteredServiceInvoice
  • PUOR : PurchaseOrder
  • SBIN : SelfBilledInvoice
  • SOAC : StatementOfAccount
  • TSUT : TradeServicesUtilityTransaction
  • VCHR : Voucher
Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"
{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocumentTypeCode

Specifies the type of referred document

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"
Discriminator
valuestringrequired
  • AROI : AccountReceivableOpenItem
  • BOLD : BillOfLading
  • CINV : CommercialInvoice
  • CMCN : CommercialContract
  • CNFA : CreditNoteRelatedToFinancialAdjustment
  • CREN : CreditNote
  • DEBN : DebitNote
  • DISP : DispatchAdvice
  • DNFA : DebitNoteRelatedToFinancialAdjustment
  • HIRI : HireInvoice
  • MSIN : MeteredServiceInvoice
  • PUOR : PurchaseOrder
  • SBIN : SelfBilledInvoice
  • SOAC : StatementOfAccount
  • TSUT : TradeServicesUtilityTransaction
  • VCHR : Voucher
Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"
{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

ReferredDocumentTypeProprietary

issuerstring<= 35 characters

Identification of the issuer of the reference document type.

schemastringrequired

Identifies the value as being either proprietary (PROPRIETARY) or as being a pre-defined code (CODE).

Enum"CODE""PROPRIETARY"
Discriminator
valuestringrequired
  • AROI : AccountReceivableOpenItem
  • BOLD : BillOfLading
  • CINV : CommercialInvoice
  • CMCN : CommercialContract
  • CNFA : CreditNoteRelatedToFinancialAdjustment
  • CREN : CreditNote
  • DEBN : DebitNote
  • DISP : DispatchAdvice
  • DNFA : DebitNoteRelatedToFinancialAdjustment
  • HIRI : HireInvoice
  • MSIN : MeteredServiceInvoice
  • PUOR : PurchaseOrder
  • SBIN : SelfBilledInvoice
  • SOAC : StatementOfAccount
  • TSUT : TradeServicesUtilityTransaction
  • VCHR : Voucher
Enum"AROI""BOLD""CINV""CMCN""CNFA""CREN""DEBN""DISP""DNFA""HIRI"
{
  "issuer": "string",
  "schema": "CODE",
  "value": "AROI"
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations
Copyright 2025 | Electrum Payments (Pty) Ltd