caad.001.001.02
The BatchManagementInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) connected to a network.
This message provides flow control information enabling a series of messages in batches and batches in collections to start, end or require checkpoints during the flow.
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
%% BatchManagementInitiationV02 recursion level 0 with max 0
BatchManagementInitiationV02 *-- "1..1" Header69 : Header
BatchManagementInitiationV02 *-- "1..1" BatchManagementInitiation2 : Body
BatchManagementInitiationV02 *-- "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
%% Header69 recursion level 0 with max 1
class Header69{
MessageFunction MessageFunction18Code
ProtocolVersion IsoMax2048Text
ExchangeIdentification IsoMax35Text
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header69 *-- "1..1" GenericIdentification183 : InitiatingParty
Header69 *-- "0..1" GenericIdentification183 : RecipientParty
Header69 *-- "0..0" AdditionalData1 : TraceData
Header69 *-- "0..0" Traceability9 : Traceability
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country ISOMax3ACountryCode
ShortName IsoMax35Text
}
%% GenericIdentification183 recursion level 1 with max 1
class GenericIdentification183{
Identification IsoMax35Text
Type PartyType17Code
OtherType IsoMax35Text
Assigner PartyType18Code
Country ISOMax3ACountryCode
ShortName IsoMax35Text
}
%% AdditionalData1 recursion level 1 with max 1
class AdditionalData1{
Type IsoMax35Text
Value IsoMax2048Text
}
%% Traceability9 recursion level 1 with max 1
class Traceability9{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability9 *-- "1..1" GenericIdentification183 : RelayIdentification
Header69 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction18Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer to issuer protocol specifications. | IsoMax2048Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange of messages between two parties. | IsoMax35Text - Optional 0..1 |
| ReTransmissionCounter | Number of retransmission of the message. Incremented by one for each retransmission. | IsoMax3NumericText - Optional 0..1 |
| CreationDateTime | Date and time at which the message was sent. | IsoISODateTime - Required 1..1 |
| InitiatingParty | Unique identification of the partner that has initiated the exchange. | GenericIdentification183 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification183 - Optional 0..1 |
| TraceData | Information sent in the request message to be returned in the response one, for instance to help in the retrieval of the context of the exchange. | AdditionalData1 - Unknown 0..0 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability9 - Unknown 0..0 |
Body building block
Information related to the batch management. Information related to the batch management. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% BatchManagementInitiation2 recursion level 0 with max 1
BatchManagementInitiation2 *-- "1..1" Environment33 : Environment
BatchManagementInitiation2 *-- "0..1" Context17 : Context
BatchManagementInitiation2 *-- "1..1" Transaction151 : Transaction
BatchManagementInitiation2 *-- "0..0" ProtectedData1 : ProtectedData
BatchManagementInitiation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment33 recursion level 1 with max 1
Environment33 *-- "0..1" PartyIdentification263 : Originator
Environment33 *-- "0..1" PartyIdentification263 : Sender
Environment33 *-- "0..1" PartyIdentification263 : Receiver
Environment33 *-- "0..1" PartyIdentification263 : Destination
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction151 recursion level 1 with max 1
class Transaction151{
BatchManagementType BatchManagementType2Code
OtherBatchManagementType IsoMax35Text
CollectionIdentification IsoMax70Text
BatchIdentification IsoMax70Text
CollectionSize IsoNumber
OriginalCollectionIdentification IsoMax70Text
OriginalBatchIdentification IsoMax70Text
NumberOfBatchesInCollection IsoNumber
NumberOfMessages IsoNumber
RemainingMessagesInCollection IsoNumber
MessageSequenceNumber IsoMax15NumericText
CollectionIdentificationList IsoMax70Text
BatchIdentificationList IsoMax70Text
CheckpointIdentification IsoMax70Text
CollectionChecksum IsoMax35Binary
BatchChecksum IsoMax35Binary
RequestAcknowledgement IsoTrueFalseIndicator
MessagesBeforeAcknowledgement IsoNumber
PositiveAcknowledgement IsoTrueFalseIndicator
ContinuationIndicator IsoTrueFalseIndicator
}
Transaction151 *-- "0..1" TransactionIdentification12 : TransactionIdentification
Transaction151 *-- "0..0" AdditionalFee2 : AdditionalFee
Transaction151 *-- "0..0" AdditionalData1 : AdditionalData
Transaction151 *-- "0..1" CorrectionIdentification1 : Correction
%% 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
BatchManagementInitiation2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | Environment33 - Required 1..1 |
| Context | Contains or describes conditions and characteristics of the transaction. | Context17 - Optional 0..1 |
| Transaction | Batch management transaction. | Transaction151 - Required 1..1 |
| ProtectedData | Contains protected data and the attributes used to protect the data. | ProtectedData1 - Unknown 0..0 |
| SupplementaryData | Additional information that can not be captured in the structured fields and/or other specific block. | SupplementaryData1 - Unknown 0..0 |
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
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MACData | Type of data protection. ISO 8583:87 bit 53 or 110 ISO 8583:93 bit 53 or 111 ISO 8583:2003 bit 53 or 50 | MACData1 - Required 1..1 |
| MAC | Message Authentication Code data. Binary, length of 8 ISO 8583 bit 64 or bit 128 | IsoMax8HexBinaryText - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the BatchManagementInitiationV02 implementation follows a specific implementaiton pattern. First of all, BatchManagementInitiationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, BatchManagementInitiationV02Document implements IOuterDocument. Because BatchManagementInitiationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type BatchManagementInitiationV02.
classDiagram
class IOuterRecord
BatchManagementInitiationV02 --|> IOuterRecord : Implements
BatchManagementInitiationV02Document --|> IOuterDocument~BatchManagementInitiationV02~ : Implements
class IOuterDocument~BatchManagementInitiationV02~ {
BatchManagementInitiationV02 Message
}
Document wrapper for serialization
The only real purpose BatchManagementInitiationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caad.001.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using BatchManagementInitiationV02.ToDocument() method. The returned BatchManagementInitiationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
BatchManagementInitiationV02Document *-- BatchManagementInitiationV02 : 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.001.001.02">
<BtchMgmtInitn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<Body>
<!-- Body inner content -->
</Body>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</BtchMgmtInitn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_31KMYYdOEeuBS50MFjViNw"
previousVersion="_CcEcRVW9EeeiG_nL4vgKnQ"
name="BatchManagementInitiationV02"
definition="The BatchManagementInitiation message can be initiated by any party and received by any party (acquirer, agent or issuer) connected to a network.

This message provides flow control information enabling a series of messages in batches and batches in collections to start, end or require checkpoints during the flow."
registrationStatus="Registered"
messageSet="_kT2-dARsEeWTJNHF-ohSqw"
xmlTag="BtchMgmtInitn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_31KMY4dOEeuBS50MFjViNw"
previousVersion="_CcEcR1W9EeeiG_nL4vgKnQ"
name="Header"
definition="Information related to the management of the protocol."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_1lM-kRvQEey2RdTw-AkXzg" />
<messageBuildingBlock
xmi:id="_31KMZYdOEeuBS50MFjViNw"
previousVersion="_CcEcSFW9EeeiG_nL4vgKnQ"
name="Body"
definition="Information related to the batch management."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Body"
complexType="_l4pjgYdOEeuBS50MFjViNw" />
<messageBuildingBlock
xmi:id="_31KMZ4dOEeuBS50MFjViNw"
previousVersion="_CcEcRlW9EeeiG_nL4vgKnQ"
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="001"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.