AcceptorBatchTransferV11

caaa.011.001.11

The AcceptorBatchTransfer is sent by an acceptor (or its agent) to transfer the financial data of a collection of transactions to the acquirer (or its agent).

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
%% AcceptorBatchTransferV11 recursion level 0 with max 0
AcceptorBatchTransferV11 *-- "1..1" Header56 : Header
AcceptorBatchTransferV11 *-- "1..1" CardPaymentBatchTransfer10 : BatchTransfer
AcceptorBatchTransferV11 *-- "0..1" ContentInformationType31 : SecurityTrailer
  

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

Header building block

Batch capture message management information. Set of characteristics related to the transfer of transactions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Header56 recursion level 0 with max 1
class Header56{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header56 *-- "1..1" GenericIdentification176 : InitiatingParty
Header56 *-- "0..1" GenericIdentification177 : RecipientParty
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
  

Header56 members

BatchTransfer building block

Card payment transactions from one or several data set of transactions. Card payment transactions from one or several data set of transactions. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CardPaymentBatchTransfer10 recursion level 0 with max 1
CardPaymentBatchTransfer10 *-- "0..0" TransactionTotals12 : TransactionTotals
CardPaymentBatchTransfer10 *-- "0..0" CardPaymentDataSet29 : DataSet
%% TransactionTotals12 recursion level 1 with max 1
class TransactionTotals12{
    POIGroupIdentification IsoMax35Text
    CardBrand IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency ActiveCurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet29 recursion level 1 with max 1
CardPaymentDataSet29 *-- "1..1" DataSetIdentification5 : DataSetIdentification
CardPaymentDataSet29 *-- "0..0" Traceability8 : Traceability
CardPaymentDataSet29 *-- "0..1" GenericIdentification176 : DataSetInitiator
CardPaymentDataSet29 *-- "1..0" TransactionTotals12 : TransactionTotals
CardPaymentDataSet29 *-- "0..1" CommonData11 : CommonData
CardPaymentDataSet29 *-- "1..0" ICardPaymentDataSetTransaction10Choice : Transaction
  

CardPaymentBatchTransfer10 members

SecurityTrailer building block

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

classDiagram
   direction tb
%% ContentInformationType31 recursion level 0 with max 1
class ContentInformationType31{
    ContentType ContentType2Code
}
ContentInformationType31 *-- "1..1" AuthenticatedData8 : AuthenticatedData
%% AuthenticatedData8 recursion level 1 with max 1
class AuthenticatedData8{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData8 *-- "1..0" IRecipient11Choice : Recipient
AuthenticatedData8 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData8 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
  

ContentInformationType31 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferV11 --|> IOuterRecord : Implements
    AcceptorBatchTransferV11Document --|> IOuterDocument~AcceptorBatchTransferV11~ : Implements
    class IOuterDocument~AcceptorBatchTransferV11~ {
        AcceptorBatchTransferV11 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferV11Document *-- AcceptorBatchTransferV11 : 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:caaa.011.001.11">
    <AccptrBtchTrf>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <BtchTrf>
            <!-- BatchTransfer inner content -->
        </BtchTrf>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrBtchTrf>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_RNeT8U0aEeybj420QgWBkA"
  nextVersions="_6ZswkXMWEe2vXY6MoVq19w"
  previousVersion="_NY6O8S49EeunNvJlR_vCbg"
  name="AcceptorBatchTransferV11"
  definition="The AcceptorBatchTransfer is sent by an acceptor (or its agent) to transfer the financial data of a collection of transactions to the acquirer (or its agent)."
  registrationStatus="Registered"
  messageSet="_fMW_EL1vEeKoB-JG4saAMg_-385897474"
  xmlTag="AccptrBtchTrf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_RNeT800aEeybj420QgWBkA"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_RNeT9U0aEeybj420QgWBkA"
    nextVersions="_6ZtXoXMWEe2vXY6MoVq19w"
    previousVersion="_NY6O9S49EeunNvJlR_vCbg"
    name="Header"
    definition="Batch capture message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_E0yzQQt-EeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_RNeT900aEeybj420QgWBkA"
    nextVersions="_6ZtXo3MWEe2vXY6MoVq19w"
    previousVersion="_NY6O9y49EeunNvJlR_vCbg"
    name="BatchTransfer"
    definition="Card payment transactions from one or several data set of transactions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrf"
    complexType="_-xhWAU0ZEeybj420QgWBkA" />
  <messageBuildingBlock
    xmi:id="_RNeT-U0aEeybj420QgWBkA"
    nextVersions="_6ZtXpXMWEe2vXY6MoVq19w"
    previousVersion="_NY6O-S49EeunNvJlR_vCbg"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_dJxbAVFFEeyApZmLzm74zA" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="011"
    flavour="001"
    version="11" />
</messageDefinition>

ISO Building Blocks

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