caaa.011.001.03
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
%% AcceptorBatchTransferV03 recursion level 0 with max 0
AcceptorBatchTransferV03 *-- "1..1" Header3 : Header
AcceptorBatchTransferV03 *-- "1..1" CardPaymentBatchTransfer2 : BatchTransfer
AcceptorBatchTransferV03 *-- "1..1" ContentInformationType9 : 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
%% Header3 recursion level 0 with max 1
class Header3{
DownloadTransfer IsoTrueFalseIndicator
FormatVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header3 *-- "1..1" GenericIdentification32 : InitiatingParty
Header3 *-- "0..1" GenericIdentification32 : RecipientParty
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
Header3 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. | IsoMax3NumericText - 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. | GenericIdentification32 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification32 - 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
%% CardPaymentBatchTransfer2 recursion level 0 with max 1
CardPaymentBatchTransfer2 *-- "0..0" TransactionTotals2 : TransactionTotals
CardPaymentBatchTransfer2 *-- "0..0" CardPaymentDataSet7 : DataSet
%% TransactionTotals2 recursion level 1 with max 1
class TransactionTotals2{
POIGroupIdentification IsoMax35Text
CardProductProfile IsoExact4NumericText
Currency CurrencyCode
Type TypeTransactionTotals2Code
TotalNumber IsoMax35NumericText
CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet7 recursion level 1 with max 1
CardPaymentDataSet7 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet7 *-- "0..0" Traceability1 : Traceability
CardPaymentDataSet7 *-- "0..1" GenericIdentification32 : DataSetInitiator
CardPaymentDataSet7 *-- "1..0" TransactionTotals2 : TransactionTotals
CardPaymentDataSet7 *-- "0..1" CommonData3 : CommonData
CardPaymentDataSet7 *-- "1..0" ICardPaymentDataSetTransaction2Choice : Transaction
CardPaymentBatchTransfer2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TransactionTotals | Totals of transactions of all the data sets. | TransactionTotals2 - Unknown 0..0 |
| DataSet | Card payment transactions from one data set of transactions. | CardPaymentDataSet7 - Unknown 0..0 |
SecurityTrailer building block
Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing protected data. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContentInformationType9 recursion level 0 with max 1
class ContentInformationType9{
ContentType ContentType1Code
}
ContentInformationType9 *-- "0..1" EnvelopedData3 : EnvelopedData
ContentInformationType9 *-- "0..1" AuthenticatedData3 : AuthenticatedData
ContentInformationType9 *-- "0..1" SignedData3 : SignedData
ContentInformationType9 *-- "0..1" DigestedData3 : DigestedData
%% EnvelopedData3 recursion level 1 with max 1
class EnvelopedData3{
Version IsoNumber
}
EnvelopedData3 *-- "1..0" IRecipient3Choice : Recipient
EnvelopedData3 *-- "1..1" EncryptedContent2 : EncryptedContent
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
%% SignedData3 recursion level 1 with max 1
class SignedData3{
Version IsoNumber
Certificate IsoMax3000Binary
}
SignedData3 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
SignedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
SignedData3 *-- "1..0" Signer2 : Signer
%% DigestedData3 recursion level 1 with max 1
class DigestedData3{
Version IsoNumber
Digest IsoMax140Text
}
DigestedData3 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
DigestedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
ContentInformationType9 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType1Code - Required 1..1 |
| EnvelopedData | Data protection by encryption, with a session key. | EnvelopedData3 - Optional 0..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData3 - Optional 0..1 |
| SignedData | Data protected by digital signatures. | SignedData3 - Optional 0..1 |
| DigestedData | Data protected by a digest. | DigestedData3 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorBatchTransferV03 implementation follows a specific implementaiton pattern. First of all, AcceptorBatchTransferV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorBatchTransferV03Document implements IOuterDocument. Because AcceptorBatchTransferV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorBatchTransferV03.
classDiagram
class IOuterRecord
AcceptorBatchTransferV03 --|> IOuterRecord : Implements
AcceptorBatchTransferV03Document --|> IOuterDocument~AcceptorBatchTransferV03~ : Implements
class IOuterDocument~AcceptorBatchTransferV03~ {
AcceptorBatchTransferV03 Message
}
Document wrapper for serialization
The only real purpose AcceptorBatchTransferV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.011.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorBatchTransferV03.ToDocument() method. The returned AcceptorBatchTransferV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorBatchTransferV03Document *-- AcceptorBatchTransferV03 : 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.03">
<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="_jRTiATSeEeOnFuyVSIQZKg"
nextVersions="_2pVhoWmEEeS7iYydEtv3Ug"
previousVersion="_iog7oQvgEeK9Xewg3qiFQA"
name="AcceptorBatchTransferV03"
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="_jdDfADSeEeOnFuyVSIQZKg"
type="purpose" />
<messageBuildingBlock
xmi:id="_jRTiAzSeEeOnFuyVSIQZKg"
nextVersions="_2pVhpWmEEeS7iYydEtv3Ug"
previousVersion="_iog7owvgEeK9Xewg3qiFQA"
name="Header"
definition="Batch capture message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SwPX0wEcEeCQm6a_G2yO_w_-1399456836" />
<messageBuildingBlock
xmi:id="_jRTiBTSeEeOnFuyVSIQZKg"
nextVersions="_2pVhp2mEEeS7iYydEtv3Ug"
previousVersion="_2cVa0C8TEeKW5usMQLtzqw"
name="BatchTransfer"
definition="Card payment transactions from one or several data set of transactions."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BtchTrf"
complexType="_KZMagTKREeOqyZqt0rCZLg" />
<messageBuildingBlock
xmi:id="_jRTiBzSeEeOnFuyVSIQZKg"
nextVersions="_2pVhqWmEEeS7iYydEtv3Ug"
previousVersion="_iog7qwvgEeK9Xewg3qiFQA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_ZSh2oTScEeOnFuyVSIQZKg" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="011"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.