Iso20022

IntraBalanceMovementCancellationQueryV01

camt.082.001.01

The IntraBalanceMovementCancellationQuery message is sent from an account owner/requestor to a settlement infrastructure to query for the status of intra-balance movement cancellation instruction(s) based on a set of search criteria or business attributes. The message may also be used to:

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
%% IntraBalanceMovementCancellationQueryV01 recursion level 0 with max 0
IntraBalanceMovementCancellationQueryV01 *-- "0..1" DocumentIdentification51 : Identification
IntraBalanceMovementCancellationQueryV01 *-- "1..1" IntraBalanceQueryDefinition7 : QueryDefinition
IntraBalanceMovementCancellationQueryV01 *-- "0..1" SupplementaryData1 : SupplementaryData

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

Identification building block

Unambiguous identification of the message as known by the account owner (or the instructing party acting on its behalf). Identification and creation date of a document. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% DocumentIdentification51 recursion level 0 with max 1
class DocumentIdentification51{
    Identification IsoMax35Text
    CopyDuplicate CopyDuplicate1Code
}
DocumentIdentification51 *-- "0..1" IDateAndDateTime2Choice : CreationDateTime
DocumentIdentification51 *-- "0..1" PartyIdentification136 : MessageOriginator
DocumentIdentification51 *-- "0..1" PartyIdentification136 : MessageRecipient
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% PartyIdentification136 recursion level 1 with max 1
class PartyIdentification136{
    LEI IsoLEIIdentifier
}
PartyIdentification136 *-- "1..1" IPartyIdentification120Choice : Identification
%% PartyIdentification136 recursion level 1 with max 1
class PartyIdentification136{
    LEI IsoLEIIdentifier
}
PartyIdentification136 *-- "1..1" IPartyIdentification120Choice : Identification

DocumentIdentification51 members

Member name Description Data Type / Multiplicity
Identification Unique identifier of the document (message) assigned by the sender of the document. IsoMax35Text - Required 1..1
CreationDateTime Date and time at which the document (message) was created by the sender. IDateAndDateTime2Choice - Optional 0..1
CopyDuplicate Specifies if this document is a copy, a duplicate, or a duplicate of a copy. CopyDuplicate1Code - Optional 0..1
MessageOriginator Party that originated the message, if other than the sender. PartyIdentification136 - Optional 0..1
MessageRecipient Party that is the final destination of the message, if other than the receiver. PartyIdentification136 - Optional 0..1

QueryDefinition building block

Defines the intra-balance movement cancellation query criteria. Defines the information that is searched through specific criteria. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IntraBalanceQueryDefinition7 recursion level 0 with max 1
class IntraBalanceQueryDefinition7{
    QueryType MovementResponseType1Code
}
IntraBalanceQueryDefinition7 *-- "1..1" IntraBalanceQueryCriteria7 : SearchCriteria
%% IntraBalanceQueryCriteria7 recursion level 1 with max 1
class IntraBalanceQueryCriteria7{
    CancellationRequestIdentification IsoMax35Text
}
IntraBalanceQueryCriteria7 *-- "0..0" ICancellationProcessingStatus9Choice : ProcessingStatus
IntraBalanceQueryCriteria7 *-- "0..0" IAccountIdentificationSearchCriteria2Choice : CashAccount
IntraBalanceQueryCriteria7 *-- "0..0" SystemPartyIdentification8 : CashAccountOwner
IntraBalanceQueryCriteria7 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : CashAccountServicer
IntraBalanceQueryCriteria7 *-- "0..0" SystemPartyIdentification8 : MessageOriginator
IntraBalanceQueryCriteria7 *-- "0..1" IDateAndDateTimeSearch5Choice : CreationDateTime

IntraBalanceQueryDefinition7 members

Member name Description Data Type / Multiplicity
QueryType Defines the type of query. MovementResponseType1Code - Required 1..1
SearchCriteria Defines the criteria to extract the intra-balance movement instruction information. IntraBalanceQueryCriteria7 - 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 IntraBalanceMovementCancellationQueryV01 implementation follows a specific implementaiton pattern. First of all, IntraBalanceMovementCancellationQueryV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, IntraBalanceMovementCancellationQueryV01Document implements IOuterDocument. Because IntraBalanceMovementCancellationQueryV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type IntraBalanceMovementCancellationQueryV01.

classDiagram
    class IOuterRecord
    IntraBalanceMovementCancellationQueryV01 --|> IOuterRecord : Implements
    IntraBalanceMovementCancellationQueryV01Document --|> IOuterDocument~IntraBalanceMovementCancellationQueryV01~ : Implements
    class IOuterDocument~IntraBalanceMovementCancellationQueryV01~ {
        IntraBalanceMovementCancellationQueryV01 Message
     }

Document wrapper for serialization

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

classDiagram
    IntraBalanceMovementCancellationQueryV01Document *-- IntraBalanceMovementCancellationQueryV01 : 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.082.001.01">
    <IntraBalMvmntCxlQry>
        <Id>
            <!-- Identification inner content -->
        </Id>
        <QryDef>
            <!-- QueryDefinition inner content -->
        </QryDef>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </IntraBalMvmntCxlQry>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DLjZYTncEem7JZMuWtwtsg"
  name="IntraBalanceMovementCancellationQueryV01"
  definition="The IntraBalanceMovementCancellationQuery message is sent from an account owner/requestor to a settlement infrastructure to query for the status of intra-balance movement cancellation instruction(s) based on a set of search criteria or business attributes.&#xD;&#xA;The message may also be used to: &#xD;&#xA;- re-send a message sent by the account owner to the account servicer (the sub-function of the message is &quot;Duplicate&quot;) &#xD;&#xA;- provide a third party with a copy of a message being sent by the account owner for information (the sub-function of the message is &quot;Copy&quot;) &#xD;&#xA;- re-send to a third party a copy of a message being sent by the account owner for information (the sub-function of the message is &quot;Copy Duplicate&quot;)."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="IntraBalMvmntCxlQry"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_DLjZaTncEem7JZMuWtwtsg"
    name="Identification"
    definition="Unambiguous identification of the message as known by the account owner (or the instructing party acting on its behalf)."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="Id"
    complexType="_BsblMTp6EemwKdP955WBJQ" />
  <messageBuildingBlock
    xmi:id="_DLjZazncEem7JZMuWtwtsg"
    name="QueryDefinition"
    definition="Defines the intra-balance movement cancellation query criteria."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="QryDef"
    complexType="_r9cTwTp6EemwKdP955WBJQ" />
  <messageBuildingBlock
    xmi:id="_DLjZbTncEem7JZMuWtwtsg"
    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="082"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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