Iso20022

CustomerPaymentCancellationRequestV01

camt.055.001.01

Scope The Customer Payment Cancellation Request message is sent by a case creator/case assigner to a case assignee. This message is used to request the cancellation of an original payment instruction. The Customer Payment Cancellation Request message is issued by the initiating party to request the cancellation of an initiation payment message previously sent (such as CustomerCreditTransferInitiation or CustomerDirectDebitInitiation). Usage The Customer Payment Cancellation Request message must be answered with a:

Message Construction

Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification

classDiagram
     direction LR
%% CustomerPaymentCancellationRequestV01 recursion level 0 with max 0
CustomerPaymentCancellationRequestV01 *-- "1..1" CaseAssignment2 : Assignment
CustomerPaymentCancellationRequestV01 *-- "0..1" Case2 : Case
CustomerPaymentCancellationRequestV01 *-- "0..1" ControlData1 : ControlData
CustomerPaymentCancellationRequestV01 *-- "1..1" UnderlyingTransaction1 : Underlying

Now, we will zero-in one-by-one on each of these building blocks.

Assignment building block

Identifies the assignment of an investigation case from an assigner to an assignee. Usage: The Assigner must be the sender of this confirmation and the Assignee must be the receiver. Set of elements used to represent the assignment of a case to a party. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CaseAssignment2 recursion level 0 with max 1
class CaseAssignment2{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
CaseAssignment2 *-- "1..1" IParty7Choice : Assigner
CaseAssignment2 *-- "1..1" IParty7Choice : Assignee
%% IParty7Choice recursion level 1 with max 1
%% IParty7Choice recursion level 1 with max 1

CaseAssignment2 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case assignment. IsoMax35Text - Required 1..1
Assigner Party who assigns the case. Usage: This is also the sender of the message.
Assignee Party to which the case is assigned. Usage: This is also the receiver of the message.
CreationDateTime Date and time at which the assignment was created. IsoISODateTime - Required 1..1

Case building block

Identifies the investigation case. Set of elements used to identify a case. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Case2 recursion level 0 with max 1
class Case2{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case2 *-- "1..1" IParty7Choice : Creator
%% IParty7Choice recursion level 1 with max 1

Case2 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case. IsoMax35Text - Required 1..1
Creator Party that created the investigation case. IParty7Choice - Required 1..1
ReopenCaseIndication Indicates whether or not the case was previously closed and is now re-opened. IsoYesNoIndicator - Optional 0..1

ControlData building block

Provides details on the number of transactions and the control sum of the message. Provides details of the number of transactions and the control sum of the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ControlData1 recursion level 0 with max 1
class ControlData1{
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
}

ControlData1 members

Member name Description Data Type / Multiplicity
NumberOfTransactions Number of individual transactions contained in the message. IsoMax15NumericText - Required 1..1
ControlSum Total of all individual amounts included in the message, irrespective of currencies. IsoDecimalNumber - Optional 0..1

Underlying building block

Identifies the payment instruction to be cancelled. Set of elements used to identify the underlying (group of) transaction(s) to which the investigation applies. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% UnderlyingTransaction1 recursion level 0 with max 1
UnderlyingTransaction1 *-- "0..1" OriginalGroupInformation23 : OriginalGroupInformationAndCancellation
UnderlyingTransaction1 *-- "0..0" OriginalPaymentInformation4 : OriginalPaymentInformationAndCancellation
%% OriginalGroupInformation23 recursion level 1 with max 1
class OriginalGroupInformation23{
    GroupCancellationIdentification IsoMax35Text
    OriginalMessageIdentification IsoMax35Text
    OriginalMessageNameIdentification IsoMax35Text
    OriginalCreationDateTime IsoISODateTime
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    GroupCancellation IsoGroupCancellationIndicator
}
OriginalGroupInformation23 *-- "0..1" Case2 : Case
OriginalGroupInformation23 *-- "0..0" CancellationReasonInformation3 : CancellationReasonInformation
%% OriginalPaymentInformation4 recursion level 1 with max 1
class OriginalPaymentInformation4{
    PaymentCancellationIdentification IsoMax35Text
    OriginalPaymentInformationIdentification IsoMax35Text
    NumberOfTransactions IsoMax15NumericText
    ControlSum IsoDecimalNumber
    PaymentInformationCancellation IsoGroupCancellationIndicator
}
OriginalPaymentInformation4 *-- "0..1" Case2 : Case
OriginalPaymentInformation4 *-- "0..1" OriginalGroupInformation3 : OriginalGroupInformation
OriginalPaymentInformation4 *-- "0..0" CancellationReasonInformation3 : CancellationReasonInformation
OriginalPaymentInformation4 *-- "0..0" PaymentTransactionInformation30 : TransactionInformation

UnderlyingTransaction1 members

Member name Description Data Type / Multiplicity
OriginalGroupInformationAndCancellation Set of elements used to provide information on the original messsage, to which the cancellation refers. OriginalGroupInformation23 - Optional 0..1
OriginalPaymentInformationAndCancellation Set of elements used to provide information on the original (group of) transactions, to which the cancellation request refers. OriginalPaymentInformation4 - Unknown 0..0

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the CustomerPaymentCancellationRequestV01 implementation follows a specific implementaiton pattern. First of all, CustomerPaymentCancellationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CustomerPaymentCancellationRequestV01Document implements IOuterDocument. Because CustomerPaymentCancellationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CustomerPaymentCancellationRequestV01.

classDiagram
    class IOuterRecord
    CustomerPaymentCancellationRequestV01 --|> IOuterRecord : Implements
    CustomerPaymentCancellationRequestV01Document --|> IOuterDocument~CustomerPaymentCancellationRequestV01~ : Implements
    class IOuterDocument~CustomerPaymentCancellationRequestV01~ {
        CustomerPaymentCancellationRequestV01 Message
     }

Document wrapper for serialization

The only real purpose CustomerPaymentCancellationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.055.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CustomerPaymentCancellationRequestV01.ToDocument() method. The returned CustomerPaymentCancellationRequestV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    CustomerPaymentCancellationRequestV01Document *-- CustomerPaymentCancellationRequestV01 : Document

Sample of message format

This is an abbreviated version of what the message should look like.

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.055.001.01">
    <CstmrPmtCxlReq>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <CtrlData>
            <!-- ControlData inner content -->
        </CtrlData>
        <Undrlyg>
            <!-- Underlying inner content -->
        </Undrlyg>
    </CstmrPmtCxlReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_RsSUuNE-Ed-BzquC8wXy7w_377163299"
  nextVersions="_sODgsFkyEeGeoaLUQk__nA_-596470641"
  previousVersion="_GZHVINEvEd-BzquC8wXy7w_162316323"
  name="CustomerPaymentCancellationRequestV01"
  definition="Scope&#xD;&#xA;The Customer Payment Cancellation Request message is sent by a case creator/case assigner to a case assignee.&#xD;&#xA;This message is used to request the cancellation of an original payment instruction. The Customer Payment Cancellation Request message is issued by the initiating party to request the cancellation of an initiation payment message previously sent (such as CustomerCreditTransferInitiation or CustomerDirectDebitInitiation).&#xD;&#xA;Usage&#xD;&#xA;The Customer Payment Cancellation Request message must be answered with a:&#xD;&#xA;- Resolution Of Investigation message with a positive final outcome when the case assignee can perform the requested cancellation&#xD;&#xA;- Resolution Of Investigation message with a negative final outcome when the case assignee may perform the requested cancellation but fails to do so (too late, irrevocable instruction.)&#xD;&#xA;- Reject Investigation message when the case assignee is unable or not authorised to perform the requested cancellation&#xD;&#xA;- Notification Of Case Assignment message to indicate whether the case assignee will take on the case himself or reassign the case to a subsequent party in the payment processing chain.&#xD;&#xA;A Customer Payment Cancellation Request message concerns one and only one original payment instruction at a time.&#xD;&#xA;When a case assignee successfully performs a cancellation, it must return the corresponding funds to the case assigner. It may provide some details about the return in the Resolution Of Investigation message.&#xD;&#xA;The processing of a Customer Payment Cancellation Request message case may lead to a Debit Authorisation Request message sent to the creditor by its account servicing institution.&#xD;&#xA;The Customer Payment Cancellation Request message may be used to escalate a case after an unsuccessful request to modify the payment. In this scenario, the case identification remains the same as in the original Customer Payment Cancellation Request message and the element ReopenCaseIndication is set to 'Yes' or 'true'."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CstmrPmtCxlReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_RscFsdE-Ed-BzquC8wXy7w_377164070"
    name="MessageOrGroupCaseRule"
    definition="Case may be present at either Case, OriginalGroupInformationAndCancellation, OriginalPaymentInformationAndCancellation or TransactionInformation level."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/Underlying[*]/OriginalGroupInformationAndCancellation/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Underlying[1]/OriginalGroupInformationAndCancellation&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_RscFtNE-Ed-BzquC8wXy7w_1861196819"
    name="MessageOrPaymentInformationCaseRule"
    definition="Case may be present at either Case, OriginalGroupInformationAndCancellation, OriginalPaymentInformationAndCancellation or TransactionInformation level."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/Underlying[*]/OriginalPaymentInformationAndCancellation[*]/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Underlying[1]/OriginalPaymentInformationAndCancellation[1]&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <constraint
    xmi:id="_RscFt9E-Ed-BzquC8wXy7w_1863964654"
    name="MessageOrTransactionCaseRule"
    definition="Case may be present at either Case, OriginalGroupInformationAndCancellation, OriginalPaymentInformationAndCancellation or TransactionInformation level."
    registrationStatus="Provisionally Registered"
    expression="&lt;RuleDefinition xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;&gt;&lt;ComplexRule xsi:type=&quot;ComplexRule&quot;&gt;&lt;mustBe&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Absence&quot;&gt;&lt;leftOperand&gt;/Underlying[*]/OriginalPaymentInformationAndCancellation[*]/TransactionInformation[*]/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/mustBe&gt;&lt;onCondition&gt;&lt;connector&gt;AND&lt;/connector&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;BooleanRule xsi:type=&quot;Presence&quot;&gt;&lt;leftOperand&gt;/Underlying[1]/OriginalPaymentInformationAndCancellation[1]/TransactionInformation[1]/Case&lt;/leftOperand&gt;&lt;/BooleanRule&gt;&lt;/onCondition&gt;&lt;/ComplexRule&gt;&lt;/RuleDefinition&gt;&#xA;" />
  <messageBuildingBlock
    xmi:id="_RsSUudE-Ed-BzquC8wXy7w_731514639"
    name="Assignment"
    definition="Identifies the assignment of an investigation case from an assigner to an assignee.&#xA;Usage: The Assigner must be the sender of this confirmation and the Assignee must be the receiver."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Assgnmt"
    complexType="_T9Nac9p-Ed-ak6NoX_4Aeg_-1609381277" />
  <messageBuildingBlock
    xmi:id="_RsSUutE-Ed-BzquC8wXy7w_377163330"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Case"
    complexType="_SpAnptp-Ed-ak6NoX_4Aeg_-1565053133" />
  <messageBuildingBlock
    xmi:id="_RsSUu9E-Ed-BzquC8wXy7w_731514361"
    name="ControlData"
    definition="Provides details on the number of transactions and the control sum of the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="CtrlData"
    complexType="_RqlQiNp-Ed-ak6NoX_4Aeg_518525040" />
  <messageBuildingBlock
    xmi:id="_RscFsNE-Ed-BzquC8wXy7w_377163639"
    name="Underlying"
    definition="Identifies the payment instruction to be cancelled."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_PmjjStp-Ed-ak6NoX_4Aeg_-1321126765" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="055"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.