ExternalPaymentCancellationRejectionCode

Electrum Regulated Payments Partner API (21.0.2)

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.

FiToFiPaymentCancellationRequest

Sent by a financial institution to request the cancellation of an instruction previously sent.

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.

assignmentobject(CaseAssignment)required

assignment.assigneeany(PartyInstitutionChoice)required

assignment.assignee.institutionobject(InstitutionIdentification)required

assignment.assignee.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignment.assignee.institution.addressobject(PostalAddress)

assignment.assignee.institution.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)

assignment.assignee.institution.branchobject(BranchIdentification)

assignment.assignee.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignment.assignee.institution.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).

assignment.assignee.institution.namestring<= 140 characters

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

assignment.assignee.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assignment.assignee.institution.memberIdstring<= 35 charactersDeprecated

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

assignment.assignee.schemastringrequired

Value"INSTITUTION"

Discriminator

assignment.assignerany(PartyInstitutionChoice)required

assignment.assigner.institutionobject(InstitutionIdentification)required

assignment.assigner.institution.additionalIdentificationsArray of objects(AccountIdentification)

assignment.assigner.institution.addressobject(PostalAddress)

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

assignment.assigner.institution.branchobject(BranchIdentification)

assignment.assigner.institution.clearingSystemMemberIdobject(ClearingSystemMemberIdentification)

assignment.assigner.institution.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).

assignment.assigner.institution.namestring<= 140 characters

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

assignment.assigner.institution.companyRegistrationstring<= 35 charactersDeprecated

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

assignment.assigner.institution.memberIdstring<= 35 charactersDeprecated

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

assignment.assigner.schemastringrequired

Value"INSTITUTION"

Discriminator

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

assignment.identificationstring<= 35 charactersrequired

Uniquely identifies a case assignment

caseobject(Case6)

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.

paymentSchemeobject(FiToFiPaymentCancellationPaymentScheme)required

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

paymentScheme.schemastring(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.
ZA_AC : South African Authenticated Collections scheme.
ZA_RMS: South African Registered Mandate Service scheme.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"

Discriminator

paymentScheme.schemeDataobject(ZaAcFiToFiPaymentCancellationPaymentSchemeData)required

paymentScheme.schemeData.cancellationTypestringrequired

Identifies the specific business process applicable to the cancellation request.

RECALL: A request to revoke a payment instruction that has not yet settled or is currently in tracking. If successful, the instruction is cancelled without financial movement (no settlement occurs). If the partner makes use of Electrum's collections capabilities, this type is only expected for outbound use.
SYSTEM_ERROR_CORRECTION_REQUEST: Represents the case where a bank has experienced a technical issue that resulted in settled debit collections being processed incorrectly (e.g., a batch of debits was duplicated), and the industry bank is requesting that the partner bank correct the error.
A successful correction means the partner bank initiates a financial Payment Return to recover the funds from the industry bank in order to refund the debtor.
This case is notably different from standard recalls and disputes in that: (1) This strictly requires prior industry/PASA authorisation to invoke, (2) it may be rejected by the partner bank if the correction cannot be applied (e.g., original transaction not found, or the transaction was already reversed via a customer dispute), (3) partial reversals are not permitted, and (4) the bank from industry is limited to exactly 2 (two) retry attempts for the same transaction if an earlier request was rejected.

Enum"RECALL""SYSTEM_ERROR_CORRECTION_REQUEST"

schemastringrequired

Value"FiToFiPaymentCancellationRequest"

underlyingTransactionobject(UnderlyingTransaction)required

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

underlyingTransaction.amountsobject(TransactionAmounts)

underlyingTransaction.creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

underlyingTransaction.creditorAgentobject(InstitutionIdentification)

underlyingTransaction.creditorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

underlyingTransaction.debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

underlyingTransaction.debtorAgentobject(InstitutionIdentification)

underlyingTransaction.debtorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

underlyingTransaction.paymentMethodstring(PaymentMethod)

CreditTransfer - Transfer of an amount of money in the books of the account servicer.
DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.

Enum"CreditTransfer""DirectDebit"

underlyingTransaction.paymentTypeInformationobject(PaymentTypeInformation)

underlyingTransaction.purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

underlyingTransaction.remittanceInformationobject(RemittanceInformation)

underlyingTransaction.settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

underlyingTransaction.supplementaryDataobject(SupplementaryData)

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

underlyingTransaction.creditorany(PartyInstitutionChoice)

underlyingTransaction.debtorany(PartyInstitutionChoice)

underlyingTransaction.mandateInformationobject(MandateInformation)

Provides details of the direct debit mandate signed between the creditor and the debtor.

NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).

underlyingTransaction.cancellationIdstring<= 35 characters

underlyingTransaction.cancellationReasonInfoArray of objects(CancellationReasonInfo)

Reason information for the cancellation

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "assignment": {
    "assignee": { … },
    "assigner": { … },
    "creationDateTime": "2019-08-24T14:15:22Z",
    "identification": "string"
  },
  "case": {
    "creator": { … },
    "identification": "string",
    "reopenCaseIndication": true
  },
  "originalTransactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "paymentScheme": {
    "schema": "ZA_RTC",
    "schemeData": { … }
  },
  "schema": "FiToFiPaymentCancellationRequest",
  "underlyingTransaction": {
    "amounts": { … },
    "creditorAccount": { … },
    "creditorAgent": { … },
    "creditorAgentAccount": { … },
    "debtorAccount": { … },
    "debtorAgent": { … },
    "debtorAgentAccount": { … },
    "paymentMethod": "CreditTransfer",
    "paymentTypeInformation": { … },
    "purpose": { … },
    "remittanceInformation": { … },
    "settlementDate": "2019-08-24",
    "supplementaryData": { … },
    "creditor": { … },
    "debtor": { … },
    "mandateInformation": { … },
    "cancellationId": "string",
    "cancellationReasonInfo": [ … ]
  }
}

ExternalPaymentCancellationRejectionCode

schemastring

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

valuestring

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. INDM 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. AACR AlreadyAcceptedRTP - Request-to-pay (RTP) has already been accepted.

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

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

CancellationStatusReason

schemastring

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

Discriminator

valuestring

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

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

Electrum Regulated Payments Partner API (21.0.2)

transactional

financial

credit-transfer

direct-debit

payment-return

identifier-determination

funds-management

risk-assessment

fraud-assessment

Schema

FiToFiPaymentCancellationRequest

ExternalPaymentCancellationRejectionCode

CancellationStatusReason

operational

bulk

request-to-pay

refund

account-verification