BatchTransferResponseV02

caad.004.001.02

The BatchTransferResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a BatchTransferInitiation message.

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
%% BatchTransferResponseV02 recursion level 0 with max 0
BatchTransferResponseV02 *-- "1..1" Header60 : Header
BatchTransferResponseV02 *-- "1..1" BatchTransferResponse2 : Body
BatchTransferResponseV02 *-- "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
%% Header60 recursion level 0 with max 1
class Header60{
    MessageFunction MessageFunction17Code
    ProtocolVersion IsoMax2048Text
    ExchangeIdentification IsoMax35Text
    ReTransmissionCounter IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header60 *-- "0..1" BatchManagementInformation1 : BatchManagementInformation
Header60 *-- "1..1" GenericIdentification183 : InitiatingParty
Header60 *-- "0..1" GenericIdentification183 : RecipientParty
Header60 *-- "0..0" AdditionalData1 : TraceData
Header60 *-- "0..0" Traceability9 : Traceability
%% BatchManagementInformation1 recursion level 1 with max 1
class BatchManagementInformation1{
    CollectionIdentification IsoMax35Text
    BatchIdentification IsoMax35Text
    MessageSequenceNumber IsoMax15NumericText
    MessageChecksumInputValue IsoMax140Binary
}
%% 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
  

Header60 members

Body building block

Information related to the batch transfer. Information related to the response of a batch transfer initiation message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BatchTransferResponse2 recursion level 0 with max 1
BatchTransferResponse2 *-- "1..1" Environment4 : Environment
BatchTransferResponse2 *-- "0..1" Context17 : Context
BatchTransferResponse2 *-- "1..1" Transaction141 : Transaction
BatchTransferResponse2 *-- "1..1" ProcessingResult13 : ProcessingResult
BatchTransferResponse2 *-- "0..0" ProtectedData1 : ProtectedData
BatchTransferResponse2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% Environment4 recursion level 1 with max 1
Environment4 *-- "0..1" Originator1 : Originator
Environment4 *-- "1..1" Destination1 : Destination
%% Context17 recursion level 1 with max 1
Context17 *-- "0..1" TransactionContext10 : TransactionContext
%% Transaction141 recursion level 1 with max 1
class Transaction141{
    BatchIdentification IsoMax70Text
    OriginalBatchIdentification IsoMax70Text
    NumberOfMessages IsoNumber
    BatchChecksum IsoMax35Binary
    RequestAcknowledgement IsoTrueFalseIndicator
}
Transaction141 *-- "0..1" TransactionIdentification12 : TransactionIdentification
Transaction141 *-- "0..0" ClearingBatchData2 : ClearingBatchData
Transaction141 *-- "0..1" ClearingControlTotals2 : ClearingControlTotals
Transaction141 *-- "0..0" AdditionalInformation21 : AgentData
Transaction141 *-- "0..0" Record2 : Record
Transaction141 *-- "0..0" AdditionalData1 : AdditionalData
%% ProcessingResult13 recursion level 1 with max 1
class ProcessingResult13{
    ApprovalCode IsoExact6AlphaNumericText
}
ProcessingResult13 *-- "0..1" ApprovalEntity2 : ResponseSource
ProcessingResult13 *-- "1..1" ResultData8 : ResultData
ProcessingResult13 *-- "0..0" ErrorDetails2 : ErrorDetail
ProcessingResult13 *-- "0..1" ResultData7 : OriginalResultData
ProcessingResult13 *-- "0..0" AdditionalInformation29 : AdditionalInformation
%% 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
  

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

classDiagram
    class IOuterRecord
    BatchTransferResponseV02 --|> IOuterRecord : Implements
    BatchTransferResponseV02Document --|> IOuterDocument~BatchTransferResponseV02~ : Implements
    class IOuterDocument~BatchTransferResponseV02~ {
        BatchTransferResponseV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    BatchTransferResponseV02Document *-- BatchTransferResponseV02 : 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.004.001.02">
    <BtchTrfRspn>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <Body>
            <!-- Body inner content -->
        </Body>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </BtchTrfRspn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_L1QloZMsEeuleeHpFMMhmQ"
  previousVersion="_w_hFlVZbEeen1vB4iz5SyA"
  name="BatchTransferResponseV02"
  definition="The BatchTransferResponse message is sent by any party to any party (acquirer, agent or issuer) in response to a BatchTransferInitiation message."
  registrationStatus="Registered"
  messageSet="_kT2-dARsEeWTJNHF-ohSqw"
  xmlTag="BtchTrfRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_L1Qlo5MsEeuleeHpFMMhmQ"
    previousVersion="_w_hFmFZbEeen1vB4iz5SyA"
    name="Header"
    definition="Information related to the management of the protocol."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_x3IU4RvREey2RdTw-AkXzg" />
  <messageBuildingBlock
    xmi:id="_L1QlpZMsEeuleeHpFMMhmQ"
    previousVersion="_w_hFl1ZbEeen1vB4iz5SyA"
    name="Body"
    definition="Information related to the batch transfer."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Body"
    complexType="_70c0cZMrEeuleeHpFMMhmQ" />
  <messageBuildingBlock
    xmi:id="_L1Qlp5MsEeuleeHpFMMhmQ"
    previousVersion="_w_hFmVZbEeen1vB4iz5SyA"
    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="004"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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