Iso20022

ModifyTransactionV08

camt.007.001.08

Scope The ModifyTransaction message is sent by a member to the transaction administrator. It is used to request one modification in one payment instruction held at the transaction administrator and sent by the member, debiting or crediting its account at the transaction administrator. Usage Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, or because of risk or liquidity limits, etc.). A transaction may have a series of statuses. These can be transient (such as pending or related types) and final (such as rejected, revoked and/or settled). Members of a system need to have information about the payments queue(s) and must have the ability to take action (that is, to cancel or modify the transaction(s) to be settled). Note, however, that actions by a member will always concern transactions in a transient status. For this reason, at any time during the operating hours of the system, the member can request modifications to the features of transient transactions. The member will submit a message requesting modifications in one or more of the following criteria:

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
%% ModifyTransactionV08 recursion level 0 with max 0
ModifyTransactionV08 *-- "1..1" MessageHeader1 : MessageHeader
ModifyTransactionV08 *-- "1..1" TransactionModification5 : Modification
ModifyTransactionV08 *-- "0..1" SupplementaryData1 : SupplementaryData

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

MessageHeader building block

Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageHeader1 members

Member name Description Data Type / Multiplicity
MessageIdentification Point to point reference, as assigned by the sender, to unambiguously identify the message. Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period. IsoMax35Text - Required 1..1
CreationDateTime Date and time at which the message was created. IsoISODateTime - Optional 0..1

Modification building block

Identifies the list of modifications to be executed. Contains the requested modifications. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% TransactionModification5 recursion level 0 with max 1
TransactionModification5 *-- "1..1" IPaymentIdentification6Choice : PaymentIdentification
TransactionModification5 *-- "1..1" PaymentInstruction33 : NewPaymentValueSet
%% IPaymentIdentification6Choice recursion level 1 with max 1
%% PaymentInstruction33 recursion level 1 with max 1
class PaymentInstruction33{
    Instruction Instruction1Code
}
PaymentInstruction33 *-- "0..1" IPaymentType4Choice : Type
PaymentInstruction33 *-- "0..1" IPriority1Choice : Priority
PaymentInstruction33 *-- "0..1" IDateTimePeriod1Choice : ProcessingValidityTime

TransactionModification5 members

Member name Description Data Type / Multiplicity
PaymentIdentification Reference to the instruction related to the payment for which a modification is requested. IPaymentIdentification6Choice - Required 1..1
NewPaymentValueSet New payment values. PaymentInstruction33 - Required 1..1

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 ModifyTransactionV08 implementation follows a specific implementaiton pattern. First of all, ModifyTransactionV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ModifyTransactionV08Document implements IOuterDocument. Because ModifyTransactionV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ModifyTransactionV08.

classDiagram
    class IOuterRecord
    ModifyTransactionV08 --|> IOuterRecord : Implements
    ModifyTransactionV08Document --|> IOuterDocument~ModifyTransactionV08~ : Implements
    class IOuterDocument~ModifyTransactionV08~ {
        ModifyTransactionV08 Message
     }

Document wrapper for serialization

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

classDiagram
    ModifyTransactionV08Document *-- ModifyTransactionV08 : 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.007.001.08">
    <ModfyTx>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <Mod>
            <!-- Modification inner content -->
        </Mod>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </ModfyTx>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jwlb6RbvEeiyVv5j1vf1VQ"
  nextVersions="_jx4tswKxEe2rHs6fbn9-0A"
  name="ModifyTransactionV08"
  definition="Scope&#xD;&#xA;The ModifyTransaction message is sent by a member to the transaction administrator.&#xD;&#xA;It is used to request one modification in one payment instruction held at the transaction administrator and sent by the member, debiting or crediting its account at the transaction administrator.&#xD;&#xA;Usage&#xD;&#xA;Following normal business flows, transactions registered by the transaction administrator may be queued for later settlement (because of insufficient funds available, or because of risk or liquidity limits, etc.). A transaction may have a series of statuses. These can be transient (such as pending or related types) and final (such as rejected, revoked and/or settled).&#xD;&#xA;Members of a system need to have information about the payments queue(s) and must have the ability to take action (that is, to cancel or modify the transaction(s) to be settled). Note, however, that actions by a member will always concern transactions in a transient status.&#xD;&#xA;For this reason, at any time during the operating hours of the system, the member can request modifications to the features of transient transactions.&#xD;&#xA;The member will submit a message requesting modifications in one or more of the following criteria:&#xD;&#xA;- instruction given, related to the processing of the transaction&#xD;&#xA;- type of payment instructed&#xD;&#xA;- priority of payment period in which the payment instruction should be processed (processing validity time)&#xD;&#xA;The ModifyTransaction message will contain the new values that the member wants to see applied to the features of the transaction identified in the message.&#xD;&#xA;Based on the criteria received within the ModifyTransaction message, the transaction administrator will execute or reject the requested modifications.&#xD;&#xA;The transaction administrator may send a Receipt message as a reply to the ModifyTransaction request.&#xD;&#xA;To verify the outcome of the request, the member may submit a GetTransaction message with the appropriate search criteria."
  registrationStatus="Registered"
  messageSet="_S0OMdGY1EeuQ__SOdbf47A"
  xmlTag="ModfyTx"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_jwlb6xbvEeiyVv5j1vf1VQ"
    nextVersions="_jx4tuQKxEe2rHs6fbn9-0A"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
  <messageBuildingBlock
    xmi:id="_jwlb7RbvEeiyVv5j1vf1VQ"
    nextVersions="_jx4tuwKxEe2rHs6fbn9-0A"
    name="Modification"
    definition="Identifies the list of modifications to be executed."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Mod"
    complexType="_B6-nbW4-EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_jwlb7xbvEeiyVv5j1vf1VQ"
    nextVersions="_jx4tvQKxEe2rHs6fbn9-0A"
    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="007"
    flavour="001"
    version="08" />
</messageDefinition>

ISO Building Blocks

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