BatchTransferInitiationV01

caad.003.001.01

The BatchTransferInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer). This message is used to transfer a series of transactions or administrative information in a single exchange.

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
%% BatchTransferInitiationV01 recursion level 0 with max 0
BatchTransferInitiationV01 *-- "1..1" Header39 : Header
BatchTransferInitiationV01 *-- "1..1" BatchTransferInitiation1 : Body
BatchTransferInitiationV01 *-- "0..1" ContentInformationType20 : SecurityTrailer
  

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

Header building block

Information related to the management of the protocol. Set of characteristics related to the protocol.

For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header39 recursion level 0 with max 1
class Header39{
    MessageFunction MessageFunction17Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header39 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header39 *-- "1..1" GenericIdentification172 : InitiatingParty
Header39 *-- "0..1" GenericIdentification172 : RecipientParty
Header39 *-- "0..0" AdditionalData1 : TraceData
Header39 *-- "0..0" Traceability7 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification172 recursion level 1 with max 1
class GenericIdentification172{
    Identification IsoMax35Text
    Type PartyType17Code
    OtherType IsoMax35Text
    Assigner PartyType18Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
    Type IsoMax35Text
    Value IsoMax2048Text
}
%% Traceability7 recursion level 1 with max 1
class Traceability7{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability7 *-- "1..1" GenericIdentification172 : RelayIdentification
  

Header39 members

Body building block

Information related to the batch transfer. Initiation of a batch transfer exchange. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BatchTransferInitiation1 recursion level 0 with max 1
BatchTransferInitiation1 *-- "1..1" Environment4 : Environment
BatchTransferInitiation1 *-- "0..1" Context8 : Context
BatchTransferInitiation1 *-- "1..1" Transaction96 : Transaction
BatchTransferInitiation1 *-- "0..1" ProcessingResult3 : ProcessingResult
BatchTransferInitiation1 *-- "0..0" ProtectedData1 : ProtectedData
BatchTransferInitiation1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment4 recursion level 1 with max 1
Environment4 *-- "0..1" Originator1 : Originator
Environment4 *-- "1..1" Destination1 : Destination
%% Context8 recursion level 1 with max 1
Context8 *-- "0..1" TransactionContext5 : TransactionContext
%% Transaction96 recursion level 1 with max 1
class Transaction96{
    BatchIdentification IsoMax70Text
    OriginalBatchIdentification IsoMax70Text
    NumberOfMessages IsoNumber
    BatchChecksum IsoMax35Binary
    RequestAcknowledgement IsoTrueFalseIndicator
}
Transaction96 *-- "0..1" TransactionIdentification10 : TransactionIdentification
Transaction96 *-- "0..0" ClearingBatchData1 : ClearingBatchData
Transaction96 *-- "0..1" ClearingControlTotals1 : ClearingControlTotals
Transaction96 *-- "0..0" AdditionalInformation21 : AgentData
Transaction96 *-- "0..0" Record1 : Record
Transaction96 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult3 recursion level 1 with max 1
ProcessingResult3 *-- "1..1" ResultData2 : ResultData
ProcessingResult3 *-- "0..1" ResultData1 : OriginalResultData
%% ProtectedData1 recursion level 1 with max 1
class ProtectedData1{
    ContentType ContentType3Code
}
ProtectedData1 *-- "0..1" EnvelopedData6 : EnvelopedData
ProtectedData1 *-- "0..1" EncryptedData1 : EncryptedData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

BatchTransferInitiation1 members

SecurityTrailer building block

Trailer of the message containing a MAC General cryptographic message syntax (CMS) containing encrypted data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType20 recursion level 0 with max 1
class ContentInformationType20{
    MAC IsoMax8HexBinaryText
}
ContentInformationType20 *-- "1..1" MACData1 : MACData
%% MACData1 recursion level 1 with max 1
class MACData1{
    Control IsoExact1HexBinaryText
    KeySetIdentifier IsoMax8NumericText
    DerivedInformation IsoMax32HexBinaryText
    Algorithm IsoMax2NumericText
    KeyLength IsoMax4NumericText
    KeyProtection IsoMax2NumericText
    KeyIndex IsoMax5NumericText
    PaddingMethod IsoMax2NumericText
    InitialisationVector IsoMax32HexBinaryText
}
  

ContentInformationType20 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    BatchTransferInitiationV01 --|> IOuterRecord : Implements
    BatchTransferInitiationV01Document --|> IOuterDocument~BatchTransferInitiationV01~ : Implements
    class IOuterDocument~BatchTransferInitiationV01~ {
        BatchTransferInitiationV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    BatchTransferInitiationV01Document *-- BatchTransferInitiationV01 : 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:caad.003.001.01">
    <BtchTrfInitn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </BtchTrfInitn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_oX5L5VXAEeeiG_nL4vgKnQ"
  nextVersions="_oMldAZMrEeuleeHpFMMhmQ"
  name="BatchTransferInitiationV01"
  definition="The BatchTransferInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer). This message is used to transfer a series of transactions or administrative information in a single exchange."
  registrationStatus="Registered"
  messageSet="_oFVkcKmaEeqA4rV5xCgycA"
  xmlTag="BtchTrfInitn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_oX5L6FXAEeeiG_nL4vgKnQ"
    nextVersions="_oMmEEZMrEeuleeHpFMMhmQ"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_4s6-AVA4EeedyPuM0kK2EQ" />
  <messageBuildingBlock
    xmi:id="_oX5L6VXAEeeiG_nL4vgKnQ"
    nextVersions="_oMmEE5MrEeuleeHpFMMhmQ"
    name="Body"
    definition="Information related to the batch transfer."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_TXEFYFA5EeedyPuM0kK2EQ" />
  <messageBuildingBlock
    xmi:id="_oX5L51XAEeeiG_nL4vgKnQ"
    nextVersions="_oMmEFZMrEeuleeHpFMMhmQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC"
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_fP-osaQuEeeWXKXf3KjtmQ" />
  <messageDefinitionIdentifier
    businessArea="caad"
    messageFunctionality="003"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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