CreditorReferenceType

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.

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

PaymentTypeInformation

categoryPurposeobject(CategoryPurpose)

localInstrumentobject(LocalInstrumentType)

serviceLevelArray of objects(ServiceLevel)

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

CreditorReferenceType

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

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

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
DISP (DispatchAdvice): Document is a dispatch advice.
PUOR (PurchaseOrder): Document is a purchase order.
SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.

Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

CreditorReferenceTypeCode

Specifies the type of creditor reference.

issuerstring<= 35 characters

Entity that assigns the credit reference type

schemastringrequired

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

Enum"CODE""PROPRIETARY"

Discriminator

valuestringrequired

RADM (RemittanceAdviceMessage): Document is a remittance advice sent separately from the current transaction.
RPIN (RelatedPaymentInstruction): Document is a linked payment instruction to which the current payment instruction is related, for example, in a cover scenario.
FXDR (ForeignExchangeDealReference): Document is a pre-agreed or pre- arranged foreign exchange transaction to which the payment transaction refers.
DISP (DispatchAdvice): Document is a dispatch advice.
PUOR (PurchaseOrder): Document is a purchase order.
SCOR (StructuredCommunicationReference): Document is a structured communication reference provided by the creditor to identify the referred transaction.

Enum"RADM""RPIN""FXDR""DISP""PUOR""SCOR"

{
  "issuer": "string",
  "schema": "CODE",
  "value": "RADM"
}

EPC API for receiving Electrum calls (17.1.0)

credit-transfer

identifier-determination

Schema

PaymentTypeInformation

CreditorReferenceType

CreditorReferenceTypeCode

transactional

request-to-pay

financial

bulk

refund