CancellationStatusReasonInformation

Electrum Regulated Payments Events API (31.2.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

CancellationStatusReason

schemastring

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

Discriminator

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": "CODE",
  "value": "AC04"
}

CancellationStatusReasonInformation

originatorobject(Party)

This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.

reasonobject(CancellationStatusReason)

{
  "originator": {
    "address": { … },
    "contactDetails": { … },
    "countryOfResidence": "string",
    "identification": { … },
    "knownAsName": "string",
    "legalName": "string"
  },
  "reason": {
    "schema": "string",
    "value": "AC04"
  }
}

CancellationStatusCode

RJCR RejectedCancellationRequest - Cancellation request is rejected
ACCR AcceptedCancellationRequest - Cancellation is accepted.
PDCR PendingCancellationRequest - Cancellation request is pending.

string(CancellationStatusCode)

RJCR RejectedCancellationRequest - Cancellation request is rejected
ACCR AcceptedCancellationRequest - Cancellation is accepted.
PDCR PendingCancellationRequest - Cancellation request is pending.

Enum"RJCR""ACCR""PDCR"

"RJCR"

Electrum Regulated Payments Events API (31.2.0)

state

Schema