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

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"
}

RequestToPayCancellationStatusReasonInfo

Provides detailed information on a cancellation status reason.

additionalInformationstring

A human friendly description of the status reason including any further details if applicable.

reasonobject(RequestToPayCancellationStatusReasonType)required

reason.schemastringrequired

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

Discriminator

reason.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"

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

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations