Iso20022

AcceptorBatchTransferV09

caaa.011.001.09

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
%% AcceptorBatchTransferV09 recursion level 0 with max 0
AcceptorBatchTransferV09 *-- "1..1" Header56 : Header
AcceptorBatchTransferV09 *-- "1..1" CardPaymentBatchTransfer8 : BatchTransfer
AcceptorBatchTransferV09 *-- "0..1" ContentInformationType24 : 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

Member name Description Data Type / Multiplicity
DownloadTransfer Indicates if the file transfer is a download or an upload. IsoTrueFalseIndicator - Required 1..1
FormatVersion Version of file format. IsoMax6Text - Required 1..1
ExchangeIdentification Unique identification of an exchange occurrence. IsoNumber - Required 1..1
CreationDateTime Date and time at which the file or message was created. IsoISODateTime - Required 1..1
InitiatingParty Unique identification of the partner that has initiated the exchange. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the exchange. GenericIdentification177 - Optional 0..1

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
%% CardPaymentBatchTransfer8 recursion level 0 with max 1
CardPaymentBatchTransfer8 *-- "0..0" TransactionTotals7 : TransactionTotals
CardPaymentBatchTransfer8 *-- "0..0" CardPaymentDataSet23 : DataSet
%% TransactionTotals7 recursion level 1 with max 1
class TransactionTotals7{
    POIGroupIdentification IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency ActiveCurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet23 recursion level 1 with max 1
CardPaymentDataSet23 *-- "1..1" DataSetIdentification5 : DataSetIdentification
CardPaymentDataSet23 *-- "0..0" Traceability8 : Traceability
CardPaymentDataSet23 *-- "0..1" GenericIdentification176 : DataSetInitiator
CardPaymentDataSet23 *-- "1..0" TransactionTotals7 : TransactionTotals
CardPaymentDataSet23 *-- "0..1" CommonData9 : CommonData
CardPaymentDataSet23 *-- "1..0" ICardPaymentDataSetTransaction8Choice : Transaction

CardPaymentBatchTransfer8 members

Member name Description Data Type / Multiplicity
TransactionTotals Totals of transactions of all the data sets. TransactionTotals7 - Unknown 0..0
DataSet Card payment transactions from one data set of transactions. CardPaymentDataSet23 - Unknown 0..0

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

ContentInformationType24 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType2Code - Required 1..1
AuthenticatedData Data protection by a message authentication code (MAC). AuthenticatedData6 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferV09 --|> IOuterRecord : Implements
    AcceptorBatchTransferV09Document --|> IOuterDocument~AcceptorBatchTransferV09~ : Implements
    class IOuterDocument~AcceptorBatchTransferV09~ {
        AcceptorBatchTransferV09 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferV09Document *-- AcceptorBatchTransferV09 : 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.09">
    <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="_lPTosQt8EeqYM5yH99IYQw"
  nextVersions="_NY6O8S49EeunNvJlR_vCbg"
  previousVersion="_hUUmMdekEeiJyp_aycJaTw"
  name="AcceptorBatchTransferV09"
  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="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrBtchTrf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_lPVd4Qt8EeqYM5yH99IYQw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_lPWE8Qt8EeqYM5yH99IYQw"
    nextVersions="_NY6O9S49EeunNvJlR_vCbg"
    previousVersion="_hUUmNdekEeiJyp_aycJaTw"
    name="Header"
    definition="Batch capture message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_E0yzQQt-EeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_lPWsAQt8EeqYM5yH99IYQw"
    nextVersions="_NY6O9y49EeunNvJlR_vCbg"
    previousVersion="_hUUmN9ekEeiJyp_aycJaTw"
    name="BatchTransfer"
    definition="Card payment transactions from one or several data set of transactions."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrf"
    complexType="_DnK60QuEEeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_lPWsAwt8EeqYM5yH99IYQw"
    nextVersions="_NY6O-S49EeunNvJlR_vCbg"
    previousVersion="_hUUmOdekEeiJyp_aycJaTw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_GpvT8QuEEeqYM5yH99IYQw" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="011"
    flavour="001"
    version="09" />
</messageDefinition>

ISO Building Blocks

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