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

ReferredDocumentAmount

duePayableAmountobject(Amount)

remittedAmountobject(Amount)

{
  "duePayableAmount": {
    "currency": "string",
    "value": 0.1
  },
  "remittedAmount": {
    "currency": "string",
    "value": 0.1
  }
}

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"
}

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations