CreditorReferenceType

Electrum Regulated Payments Partner API (17.1.0)

The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in the Electrum Regulated Payments Partner API.
Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in this document.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.

This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments 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"
}

Electrum Regulated Payments Partner API (17.1.0)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

Schema

PaymentTypeInformation

CreditorReferenceType

CreditorReferenceTypeCode

operational

bulk

request-to-pay

refund

account-verification