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

RequestToPayCancellationResponse

Provides the outcome of a prior request to pay cancellation.

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

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.

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

originalRequestToPayDataobject(OriginalRequestToPayData)

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

originalTransactionIdentifiersobject(TransactionIdentifiers)required

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

originalTransactionIdentifiers.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.

originalTransactionIdentifiers.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.

originalTransactionIdentifiers.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.

originalTransactionIdentifiers.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.

schemastringrequired

Value"RequestToPayCancellationResponse"

statusobject(RequestToPayCancellationStatus)required

status.reasonInfoArray of objects(RequestToPayCancellationStatusReasonInfo)non-empty

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

status.statusstringrequired

CANCELLED: Cancelled - The cancellation was successfully processed and the request for payment has been cancelled.
REJECTED: Rejected - The cancellation was rejected. Refer to the reasonInfo for further information.

Enum"CANCELLED""REJECTED"

{
  "instructedAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "instructingAgent": {
    "additionalIdentifications": [ … ],
    "address": { … },
    "bicfi": "string",
    "branch": { … },
    "clearingSystemMemberId": { … },
    "companyRegistration": "string",
    "lei": "string",
    "memberId": "string",
    "name": "string"
  },
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "originalRequestToPayData": {
    "amounts": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "requestToPayConditions": { … }
  },
  "originalTransactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "schema": "RequestToPayCancellationResponse",
  "status": {
    "reasonInfo": [ … ],
    "status": "CANCELLED"
  }
}

InitiationStatus

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"

reasonInfoArray of objects(StatusReasonInfo)non-empty

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

{
  "outcome": "RECEIVED",
  "reasonInfo": [
    { … }
  ]
}

PaymentInstructionStatusReport

This message is used to report information about the positive or negative status of an individual credit transfer/direct debit instruction submitted within a bulk initiation, or to report on a pending instruction.

The field originalTransactionData is not mandatory, but will always be populated in payment status reports sent by Electrum.

originalTransactionDataobject(OriginalTransactionData)

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

paymentSchemeobject(PaymentStatusReportPaymentScheme)required

Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.

paymentScheme.schemastringrequired

Discriminator

statusobject(Status)required

status.outcomestringrequired

APPROVED: The instruction has been approved.
CANCELLED: The instruction has been cancelled.
PENDING: The instruction is pending.
REJECTED: The instruction has been rejected.

Enum"APPROVED""CANCELLED""PENDING""REJECTED"

status.reasonInfoArray of objects(StatusReasonInfo)non-empty

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

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

transactionIdentifiers.instructionIdentificationstring<= 35 characters

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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.

{
  "originalTransactionData": {
    "amounts": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "paymentMethod": "CreditTransfer",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "settlementDate": "2019-08-24",
    "supplementaryData": { … },
    "creditor": { … },
    "debtor": { … }
  },
  "paymentScheme": {
    "originalSchemeData": { … },
    "schema": "ZA_RTC",
    "schemeData": { … }
  },
  "status": {
    "outcome": "APPROVED",
    "reasonInfo": [ … ]
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  }
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations