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

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

PaymentInitiationStatusReport

This message is used to report information about the positive or negative status of a bulk payment initiation (Multiple Credit Transfers/Direct Debits)

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

A reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.creationDateTimestring(date-time)required

The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

controlSumobject(Amount)

creditorAgentobject(InstitutionIdentification)

debtorAgentobject(InstitutionIdentification)required

debtorAgent.additionalIdentificationsArray of objects(AccountIdentification)

debtorAgent.addressobject(PostalAddress)

debtorAgent.bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

debtorAgent.branchobject(BranchIdentification)

debtorAgent.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

debtorAgent.leistring[A-Z0-9]{18,18}[0-9]{2,2}

An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).

debtorAgent.namestring<= 140 characters

Name by which an institution is known and which is usually used to identify that institution

debtorAgent.companyRegistrationstring<= 35 charactersDeprecated

A unique identifier assigned to a company or organisation by a duly appointed authority within a country.

debtorAgent.memberIdstring<= 35 charactersDeprecated

Deprecated. Please use the preferred clearingSystemMemberId.memberId instead. Identification of a member of a clearing system.

numberOfTransactionsinteger

Number of individual credit transfer instructions within the bulk that should be initiated.

paymentInformationIdstring(UUID)required

Universally unique identifier to provide an end-to-end reference to the bulk initiation. This identifier remains the same for all messages related to the bulk transaction. Note: this is distinct from the UETR's of the individual credit transfers.

paymentInitiationStatusobject(InitiationStatus)required

paymentInitiationStatus.outcomestringrequired

RECEIVED: The bulk initiation has been received.
PENDING: The bulk initiation is undergoing pre-checks.
ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.
COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.
REJECTED: The bulk initiation has been rejected.

Enum"RECEIVED""PENDING""ACCEPTED""COMPLETED""REJECTED"

paymentInitiationStatus.reasonInfoArray of objects(StatusReasonInfo)non-empty

A list of StatusReasonInfo values providing detailed reason information for the outcome.

paymentInstructionStatusReportsArray of objects(PaymentInstructionStatusReport)

List of payment status reports relating to each credit initiation instruction received and actioned

paymentSchemeNamestring(PaymentSchemeName)required

Identifies the scheme used for the payment

ZA_RTC: South African Realtime Clearing scheme.
ZA_RPP: South African Realtime Payments Platform scheme.
ZA_EFT: South African Electronic Funds Transfer scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

schemastringrequired

Value"PaymentInitiationStatusReport"

transactionStatisticsobject(TransactionStatistics)required

A detailed breakdown of the number of transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

transactionStatistics.numberOfApprovedTransactionsintegerrequired

Count of transactions with the APPROVED status.

transactionStatistics.numberOfCancelledTransactionsintegerrequired

Count of transactions with the CANCELLED status.

transactionStatistics.numberOfPendingTransactionsintegerrequired

Count of transactions with the PENDING status.

transactionStatistics.numberOfRejectedTransactionsintegerrequired

Count of transactions with the REJECTED status.

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "controlSum": {
    "currency": "string",
    "value": 0.1
  },
  "creditorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "debtorAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "numberOfTransactions": 0,
  "paymentInformationId": "string",
  "paymentInitiationStatus": {
    "outcome": "RECEIVED",
    "reasonInfo": [ … ]
  },
  "paymentInstructionStatusReports": [
    { … }
  ],
  "paymentSchemeName": "ZA_RTC",
  "schema": "PaymentInitiationStatusReport",
  "transactionStatistics": {
    "numberOfApprovedTransactions": 0,
    "numberOfCancelledTransactions": 0,
    "numberOfPendingTransactions": 0,
    "numberOfRejectedTransactions": 0
  }
}

RequestToPayInstructionStatusReport

Reports the status of an individual request to pay transaction in a bulk message.

originalRequestToPayDataobject(OriginalRequestToPayData)

Contains key elements related to the original request to pay that is being referred to.

statusobject(RequestToPayStatus)required

status.reasonInfoArray of objects(RequestToPayStatusReasonInfo)non-empty

A list of RequestToPayStatusReasonInfo values providing detailed reason information for the status.

status.statusstringrequired

PAID: Paid - The request to pay was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated.
ACCEPTED: Accepted - The request to pay was approved by the debtor but the payment has not yet been processed.
CANCELLED: Cancelled - Request to pay has been successfully cancelled after having received a request for cancellation.
EXPIRED: Expired - The request to pay has expired.
PENDING: Pending - The request to pay has been forwarded and an intial status report is still expected.
PRESENTED: Presented - The request to pay has been accepted by the payer participant and will be presented to the debtor.
REJECTED: Rejected - The request to pay has been rejected.
REFUND_IN_PROGRESS: Refund in progress - The refund of the original request to pay is currently in progress and does not yet have an outcome
REFUNDED: Refunded - The refund of the original request to pay has been completed successfully

Enum"PAID""ACCEPTED""CANCELLED""EXPIRED""PENDING""PRESENTED""REJECTED""REFUND_IN_PROGRESS""REFUNDED"

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.

transactionIdentifiers.instructionIdentificationstring<= 35 characters

Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.

transactionIdentifiers.uetrstring(UUID)required

Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.

{
  "originalRequestToPayData": {
    "amounts": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "requestToPayConditions": { … }
  },
  "status": {
    "reasonInfo": [ … ],
    "status": "PAID"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}

RequestToPayTransactionStatistics

A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.

numberOfAcceptedTransactionsintegerrequired

Count of transactions with the ACCEPTED status.

numberOfCancelledTransactionsintegerrequired

Count of transactions with the CANCELLED status.

numberOfExpiredTransactionsintegerrequired

Count of transactions with the EXPIRED status.

numberOfPaidTransactionsintegerrequired

Count of transactions with the PAID status.

numberOfPendingTransactionsintegerrequired

Count of transactions with the PENDING status.

numberOfPresentedTransactionsintegerrequired

Count of transactions with the PRESENT status.

numberOfRejectedTransactionsintegerrequired

Count of transactions with the REJECTED status.

numberOfUnsubmittedTransactionsintegerrequired

number of transactions not yet sent to industry, and thus do not yet have an official RTP state.

{
  "numberOfAcceptedTransactions": 0,
  "numberOfCancelledTransactions": 0,
  "numberOfExpiredTransactions": 0,
  "numberOfPaidTransactions": 0,
  "numberOfPendingTransactions": 0,
  "numberOfPresentedTransactions": 0,
  "numberOfRejectedTransactions": 0,
  "numberOfUnsubmittedTransactions": 0
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations