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

RequestToPayResponse

An extension of BaseTransactionMessage which includes additional information pertinent to an asynchronous response message. In particular, original message identifiers.

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

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.

instructedAgentobject(InstitutionIdentification)

instructingAgentobject(InstitutionIdentification)

originalRequestToPayDataobject(OriginalRequestToPayData)

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

requestToPayConditionsobject(RequestToPayConditions)

Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.

schemastringrequired

Value"RequestToPayResponse"

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"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "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"
  },
  "originalRequestToPayData": {
    "amounts": { … },
    "creditor": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "debtor": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "expiryDateTime": "2019-08-24T14:15:22Z",
    "paymentTypeInformation": { … },
    "remittanceInformation": { … },
    "requestToPayConditions": { … }
  },
  "requestToPayConditions": {
    "maxAmount": { … },
    "minAmount": { … }
  },
  "schema": "RequestToPayResponse",
  "status": {
    "reasonInfo": [ … ],
    "status": "PAID"
  }
}

RequestToPayCancellationStatusReasonTypeCode

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

valuestringrequired

AC04: ClosedAccountNumber - Account number specified has been closed on the receiver’s books.
ADAC: AwaitingDebitAuthorityFromCustomer - Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account.
AGNT: AgentDecision - Reported when the cancellation cannot be accepted because of an agent refuses to cancel.
AM04: InsufficientFunds - Amount of funds available to cover specified message amount is insufficient.
ARDT: AlreadyReturned - Cancellation not accepted as the transaction has already been returned.
ARPL: AwaitinReply - Reported when the cancellation request cannot be processed because no reply has been received yet from the receiver of the request message.
CUST: CustomerDecision - Reported when the cancellation cannot be accepted because of a customer decision (Creditor).
LEGL: LegalDecision - Reported when the cancellation cannot be accepted because of regulatory rules.
NARR: Narrative - Reason is provided as narrative information in the additional reason information.
NOAS: NoAnswerFromCustomer - No response from beneficiary (to the cancellation request).
NOOR: NoOriginalTransactionReceived - Original transaction (subject to cancellation) never received.
PTNA: PassedToTheNextAgent - Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent.
RQDA: RequestingDebitAuthority - Reported when authority is required by the Creditor to return the payment.
WSEQ: WrongSequence - Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid.
IDMN: CancellationIndemnityRequired - Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established.
ACLR: AlreadyCancelledRTP - Request-to-pay has already been cancelled.
AEXR: AlreadyExpiredRTP - Request-to-pay Expiry Date and Time has already passed.
ARFR: AlreadyRefusedRTP - Request-to-pay has already been refused by the Debtor.
ARJR: AlreadyRejectedRTP - Request-to-pay has already been rejected.
PATE: PaymentAlreadyTransmittedExecution - Payment related to the request-to-pay has already been transmitted for execution.
RR04: RegulatoryReason - Regulatory Reason.
RCAR: RfCAlreadyRejected - Request for cancellation of the request-to-pay has already been rejected.
RCNR: RfCNeverReceived - Request for cancellation of the request-to-pay has never been received.
RCPR: RfCReceivedAndProcessed - Request for cancellation of the request-to-pay has already been received and processed.
URTP: UnknownRTP - Request-to-pay is unknown.

Enum"AC04""ADAC""AGNT""AM04""ARDT""ARPL""CUST""LEGL""NARR""NOAS"

{
  "schema": "string",
  "value": "AC04"
}

RequestToPayCancellationStatusReasonType

schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator

valuestringrequired

AC04: ClosedAccountNumber - Account number specified has been closed on the receiver’s books.
ADAC: AwaitingDebitAuthorityFromCustomer - Reported when the cancellation request cannot be processed because customer has not yet provided the debit authority on its account.
AGNT: AgentDecision - Reported when the cancellation cannot be accepted because of an agent refuses to cancel.
AM04: InsufficientFunds - Amount of funds available to cover specified message amount is insufficient.
ARDT: AlreadyReturned - Cancellation not accepted as the transaction has already been returned.
ARPL: AwaitinReply - Reported when the cancellation request cannot be processed because no reply has been received yet from the receiver of the request message.
CUST: CustomerDecision - Reported when the cancellation cannot be accepted because of a customer decision (Creditor).
LEGL: LegalDecision - Reported when the cancellation cannot be accepted because of regulatory rules.
NARR: Narrative - Reason is provided as narrative information in the additional reason information.
NOAS: NoAnswerFromCustomer - No response from beneficiary (to the cancellation request).
NOOR: NoOriginalTransactionReceived - Original transaction (subject to cancellation) never received.
PTNA: PassedToTheNextAgent - Reported when the cancellation request cannot be accepted because the payment instruction has been passed to the next agent.
RQDA: RequestingDebitAuthority - Reported when authority is required by the Creditor to return the payment.
WSEQ: WrongSequence - Reported when the cancellation request cannot be processed because the sequence referred to in the request is not valid.
IDMN: CancellationIndemnityRequired - Complementing a Pending or Reject Status. Payment cancellation request cannot be accepted until an indemnity agreement is established.
ACLR: AlreadyCancelledRTP - Request-to-pay has already been cancelled.
AEXR: AlreadyExpiredRTP - Request-to-pay Expiry Date and Time has already passed.
ARFR: AlreadyRefusedRTP - Request-to-pay has already been refused by the Debtor.
ARJR: AlreadyRejectedRTP - Request-to-pay has already been rejected.
PATE: PaymentAlreadyTransmittedExecution - Payment related to the request-to-pay has already been transmitted for execution.
RR04: RegulatoryReason - Regulatory Reason.
RCAR: RfCAlreadyRejected - Request for cancellation of the request-to-pay has already been rejected.
RCNR: RfCNeverReceived - Request for cancellation of the request-to-pay has never been received.
RCPR: RfCReceivedAndProcessed - Request for cancellation of the request-to-pay has already been received and processed.
URTP: UnknownRTP - Request-to-pay is unknown.

Enum"AC04""ADAC""AGNT""AM04""ARDT""ARPL""CUST""LEGL""NARR""NOAS"

{
  "schema": "CODE",
  "value": "AC04"
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations