Iso20022

UnableToApplyV04

camt.026.001.04

Scope The Unable To Apply message is sent by a case creator or a case assigner to a case assignee. This message is used to initiate an investigation of a payment instruction that cannot be executed or reconciled. Usage The Unable To Apply case occurs in two situations:

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
%% UnableToApplyV04 recursion level 0 with max 0
UnableToApplyV04 *-- "1..1" CaseAssignment3 : Assignment
UnableToApplyV04 *-- "1..1" Case3 : Case
UnableToApplyV04 *-- "1..1" IUnderlyingTransaction2Choice : Underlying
UnableToApplyV04 *-- "1..1" IUnableToApplyJustification2Choice : Justification
UnableToApplyV04 *-- "0..1" SupplementaryData1 : SupplementaryData

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. Represents the assignment of a case to a party. For comparison, see the ISO20022 official specification

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

CaseAssignment3 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. Provides further details to identify an investigation case. For comparison, see the ISO20022 official specification

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

Case3 members

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

Underlying building block

References the payment instruction or statement entry that a party is unable to execute or unable to reconcile. Specifies the details of the underlying transaction on which the investigation is processed. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IUnderlyingTransaction2Choice recursion level 0 with max 1

UnderlyingTransaction2Choice members

Member name Description Data Type / Multiplicity

Justification building block

Explains the reason why the case creator is unable to apply the instruction. Specifies the details of missing information or the complete set of available information. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IUnableToApplyJustification2Choice recursion level 0 with max 1

UnableToApplyJustification2Choice members

Member name Description Data Type / Multiplicity

SupplementaryData building block

Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1

SupplementaryData1 members

Member name Description Data Type / Multiplicity
PlaceAndName Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. IsoMax350Text - Optional 0..1
Envelope Technical element wrapping the supplementary data. IsoSupplementaryDataEnvelope1 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    UnableToApplyV04 --|> IOuterRecord : Implements
    UnableToApplyV04Document --|> IOuterDocument~UnableToApplyV04~ : Implements
    class IOuterDocument~UnableToApplyV04~ {
        UnableToApplyV04 Message
     }

Document wrapper for serialization

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

classDiagram
    UnableToApplyV04Document *-- UnableToApplyV04 : 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.026.001.04">
    <UblToApply>
        <Assgnmt>
            <!-- Assignment inner content -->
        </Assgnmt>
        <Case>
            <!-- Case inner content -->
        </Case>
        <Undrlyg>
            <!-- Underlying inner content -->
        </Undrlyg>
        <Justfn>
            <!-- Justification inner content -->
        </Justfn>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </UblToApply>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_sMkS8FkyEeGeoaLUQk__nA_-161761575"
  nextVersions="_1ksHkUglEeaGKYpLDboHPQ"
  previousVersion="_hCmh-NE_Ed-BzquC8wXy7w_120677065"
  name="UnableToApplyV04"
  definition="Scope&#xD;&#xA;The Unable To Apply message is sent by a case creator or a case assigner to a case assignee. This message is used to initiate an investigation of a payment instruction that cannot be executed or reconciled.&#xD;&#xA;Usage&#xD;&#xA;The Unable To Apply case occurs in two situations:&#xD;&#xA;- an agent cannot execute the payment instruction due to missing or incorrect information&#xD;&#xA;- a creditor cannot reconcile the payment entry as it is received unexpectedly, or missing or incorrect information prevents reconciliation&#xD;&#xA;The Unable To Apply message&#xD;&#xA;- always follows the reverse route of the original payment instruction&#xD;&#xA;- must be forwarded to the preceding agents in the payment processing chain, where appropriate&#xD;&#xA;- covers one and only one payment instruction (or payment entry) at a time; if several payment instructions cannot be executed or several payment entries cannot be reconciled, then multiple Unable To Apply messages must be sent.&#xD;&#xA;Depending on what stage the payment is and what has been done to it, for example incorrect routing, errors/omissions when processing the instruction or even the absence of any error, the unable to apply case may lead to a:&#xD;&#xA;- Additional Payment Information message, sent to the case creator/case assigner, if a truncation or omission in a payment instruction prevented reconciliation.&#xD;&#xA;- Request To Cancel Payment message, sent to the subsequent agent in the payment processing chain, if the original payment instruction has been incorrectly routed through the chain of agents (this also entails a new corrected payment instruction being issued). Prior to sending the payment cancellation request, the agent should first send a resolution indicating that a cancellation will follow (CWFW).&#xD;&#xA;- Request To Modify Payment message, sent to the subsequent agent in the payment processing chain, if a truncation or omission has occurred during the processing of the original payment instruction. Prior to sending the modify payment request, the agent should first send a resolution indicating that a modification will follow (MWFW).&#xD;&#xA;- Debit Authorisation Request message, sent to the case creator/case assigner, if the payment instruction has reached an incorrect creditor.&#xD;&#xA;The UnableToApply message has the following main characteristics:&#xD;&#xA;The case creator (the instructed party/creditor of a payment instruction) assigns a unique case identification and optionally the reason code for the Unable To Apply message. This information will be passed unchanged to all subsequent case assignees.&#xD;&#xA;The case creator specifies the identification of the underlying payment instruction. This identification needs to be updated by the subsequent case assigner(s) in order to match the one used with their case assignee(s).&#xD;&#xA;The Unable To Apply Justification element allows the assigner to indicate whether a specific element causes the unable to apply situation (incorrect element and/or mismatched element can be listed) or whether any supplementary information needs to be forwarded."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="UblToApply"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_sMtc4FkyEeGeoaLUQk__nA_-1552715328"
    nextVersions="_1ksHnUglEeaGKYpLDboHPQ"
    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="_sbKvolkyEeGeoaLUQk__nA_1583838951" />
  <messageBuildingBlock
    xmi:id="_sMtc4VkyEeGeoaLUQk__nA_1859018681"
    nextVersions="_1ksHn0glEeaGKYpLDboHPQ"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_tijOcFkyEeGeoaLUQk__nA_-1838378407" />
  <messageBuildingBlock
    xmi:id="_sMtc4lkyEeGeoaLUQk__nA_1745179615"
    nextVersions="_1ksHoUglEeaGKYpLDboHPQ"
    name="Underlying"
    definition="References the payment instruction or statement entry that a party is unable to execute or unable to reconcile."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Undrlyg"
    complexType="_P3N9Vp9XEeGBX4a4yy-WHg_2030305441" />
  <messageBuildingBlock
    xmi:id="_sNAX0FkyEeGeoaLUQk__nA_861946328"
    nextVersions="_1ksHo0glEeaGKYpLDboHPQ"
    name="Justification"
    definition="Explains the reason why the case creator is unable to apply the instruction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Justfn"
    complexType="_T-i3M9p-Ed-ak6NoX_4Aeg_-1089125452" />
  <messageBuildingBlock
    xmi:id="_sNAX0VkyEeGeoaLUQk__nA_115408856"
    nextVersions="_1ksHpUglEeaGKYpLDboHPQ"
    name="SupplementaryData"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SplmtryData"
    complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="026"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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