AcceptorBatchTransferV12

caaa.011.001.12

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
%% AcceptorBatchTransferV12 recursion level 0 with max 0
AcceptorBatchTransferV12 *-- "1..1" Header56 : Header
AcceptorBatchTransferV12 *-- "1..1" CardPaymentBatchTransfer11 : BatchTransfer
AcceptorBatchTransferV12 *-- "0..1" ContentInformationType36 : 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
%% CardPaymentBatchTransfer11 recursion level 0 with max 1
CardPaymentBatchTransfer11 *-- "0..0" TransactionTotals12 : TransactionTotals
CardPaymentBatchTransfer11 *-- "0..0" CardPaymentDataSet34 : DataSet
%% TransactionTotals12 recursion level 1 with max 1
class TransactionTotals12{
    POIGroupIdentification IsoMax35Text
    CardBrand IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency ActiveCurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet34 recursion level 1 with max 1
CardPaymentDataSet34 *-- "1..1" DataSetIdentification5 : DataSetIdentification
CardPaymentDataSet34 *-- "0..0" Traceability8 : Traceability
CardPaymentDataSet34 *-- "0..1" GenericIdentification176 : DataSetInitiator
CardPaymentDataSet34 *-- "1..0" TransactionTotals12 : TransactionTotals
CardPaymentDataSet34 *-- "0..1" CommonData12 : CommonData
CardPaymentDataSet34 *-- "1..0" ICardPaymentDataSetTransaction11Choice : Transaction
  

CardPaymentBatchTransfer11 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
%% ContentInformationType36 recursion level 0 with max 1
class ContentInformationType36{
    ContentType ContentType2Code
}
ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData
%% AuthenticatedData9 recursion level 1 with max 1
class AuthenticatedData9{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient
AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
  

ContentInformationType36 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferV12 --|> IOuterRecord : Implements
    AcceptorBatchTransferV12Document --|> IOuterDocument~AcceptorBatchTransferV12~ : Implements
    class IOuterDocument~AcceptorBatchTransferV12~ {
        AcceptorBatchTransferV12 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferV12Document *-- AcceptorBatchTransferV12 : 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.12">
    <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="_6ZswkXMWEe2vXY6MoVq19w"
  previousVersion="_RNeT8U0aEeybj420QgWBkA"
  name="AcceptorBatchTransferV12"
  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="_uZD3QJVOEeO6Q83g-JIX_w"
  xmlTag="AccptrBtchTrf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_6Zswk3MWEe2vXY6MoVq19w"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_6ZtXoXMWEe2vXY6MoVq19w"
    previousVersion="_RNeT9U0aEeybj420QgWBkA"
    name="Header"
    definition="Batch capture message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_E0yzQQt-EeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_6ZtXo3MWEe2vXY6MoVq19w"
    previousVersion="_RNeT900aEeybj420QgWBkA"
    name="BatchTransfer"
    definition="Card payment transactions from one or several data set of transactions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrf"
    complexType="_ivjdcXJ8Ee299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_6ZtXpXMWEe2vXY6MoVq19w"
    previousVersion="_RNeT-U0aEeybj420QgWBkA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="011"
    flavour="001"
    version="12" />
</messageDefinition>

ISO Building Blocks

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