caaa.011.001.04
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
%% AcceptorBatchTransferV04 recursion level 0 with max 0
AcceptorBatchTransferV04 *-- "1..1" Header12 : Header
AcceptorBatchTransferV04 *-- "1..1" CardPaymentBatchTransfer3 : BatchTransfer
AcceptorBatchTransferV04 *-- "1..1" ContentInformationType12 : 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
%% Header12 recursion level 0 with max 1
class Header12{
DownloadTransfer IsoTrueFalseIndicator
FormatVersion IsoMax6Text
ExchangeIdentification IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header12 *-- "1..1" GenericIdentification53 : InitiatingParty
Header12 *-- "0..1" GenericIdentification53 : RecipientParty
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
Header12 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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the exchange. | GenericIdentification53 - 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
%% CardPaymentBatchTransfer3 recursion level 0 with max 1
CardPaymentBatchTransfer3 *-- "0..0" TransactionTotals3 : TransactionTotals
CardPaymentBatchTransfer3 *-- "0..0" CardPaymentDataSet10 : DataSet
%% TransactionTotals3 recursion level 1 with max 1
class TransactionTotals3{
POIGroupIdentification IsoMax35Text
CardProductProfile IsoMax35Text
Currency CurrencyCode
Type TypeTransactionTotals2Code
TotalNumber IsoNumber
CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet10 recursion level 1 with max 1
CardPaymentDataSet10 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet10 *-- "0..0" Traceability2 : Traceability
CardPaymentDataSet10 *-- "0..1" GenericIdentification53 : DataSetInitiator
CardPaymentDataSet10 *-- "1..0" TransactionTotals3 : TransactionTotals
CardPaymentDataSet10 *-- "0..1" CommonData4 : CommonData
CardPaymentDataSet10 *-- "1..0" ICardPaymentDataSetTransaction3Choice : Transaction
CardPaymentBatchTransfer3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TransactionTotals | Totals of transactions of all the data sets. | TransactionTotals3 - Unknown 0..0 |
| DataSet | Card payment transactions from one data set of transactions. | CardPaymentDataSet10 - 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
%% ContentInformationType12 recursion level 0 with max 1
class ContentInformationType12{
ContentType ContentType2Code
}
ContentInformationType12 *-- "0..1" EnvelopedData4 : EnvelopedData
ContentInformationType12 *-- "0..1" AuthenticatedData4 : AuthenticatedData
ContentInformationType12 *-- "0..1" SignedData4 : SignedData
ContentInformationType12 *-- "0..1" DigestedData4 : DigestedData
%% EnvelopedData4 recursion level 1 with max 1
class EnvelopedData4{
Version IsoNumber
}
EnvelopedData4 *-- "1..0" IRecipient4Choice : Recipient
EnvelopedData4 *-- "0..1" EncryptedContent3 : EncryptedContent
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
%% SignedData4 recursion level 1 with max 1
class SignedData4{
Version IsoNumber
Certificate IsoMax5000Binary
}
SignedData4 *-- "1..0" AlgorithmIdentification16 : DigestAlgorithm
SignedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
SignedData4 *-- "1..0" Signer3 : Signer
%% DigestedData4 recursion level 1 with max 1
class DigestedData4{
Version IsoNumber
Digest IsoMax140Binary
}
DigestedData4 *-- "1..1" AlgorithmIdentification16 : DigestAlgorithm
DigestedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType12 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContentType | Type of data protection. | ContentType2Code - Required 1..1 |
| EnvelopedData | Data protection by encryption, with a session key. | EnvelopedData4 - Optional 0..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData4 - Optional 0..1 |
| SignedData | Data protected by a digital signatures. | SignedData4 - Optional 0..1 |
| DigestedData | Data protected by a digest. | DigestedData4 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorBatchTransferV04 implementation follows a specific implementaiton pattern. First of all, AcceptorBatchTransferV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorBatchTransferV04Document implements IOuterDocument. Because AcceptorBatchTransferV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorBatchTransferV04.
classDiagram
class IOuterRecord
AcceptorBatchTransferV04 --|> IOuterRecord : Implements
AcceptorBatchTransferV04Document --|> IOuterDocument~AcceptorBatchTransferV04~ : Implements
class IOuterDocument~AcceptorBatchTransferV04~ {
AcceptorBatchTransferV04 Message
}
Document wrapper for serialization
The only real purpose AcceptorBatchTransferV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.011.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorBatchTransferV04.ToDocument() method. The returned AcceptorBatchTransferV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorBatchTransferV04Document *-- AcceptorBatchTransferV04 : 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.04">
<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="_2pVhoWmEEeS7iYydEtv3Ug"
nextVersions="_5M7M4Y3FEeWjkqXgn_0Imw"
previousVersion="_jRTiATSeEeOnFuyVSIQZKg"
name="AcceptorBatchTransferV04"
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="_2pVho2mEEeS7iYydEtv3Ug"
type="purpose" />
<messageBuildingBlock
xmi:id="_2pVhpWmEEeS7iYydEtv3Ug"
nextVersions="_5M7M5Y3FEeWjkqXgn_0Imw"
previousVersion="_jRTiAzSeEeOnFuyVSIQZKg"
name="Header"
definition="Batch capture message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_-uGCQWmEEeS7iYydEtv3Ug" />
<messageBuildingBlock
xmi:id="_2pVhp2mEEeS7iYydEtv3Ug"
nextVersions="_5M7M543FEeWjkqXgn_0Imw"
previousVersion="_jRTiBTSeEeOnFuyVSIQZKg"
name="BatchTransfer"
definition="Card payment transactions from one or several data set of transactions."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BtchTrf"
complexType="_NvxRsWmFEeS7iYydEtv3Ug" />
<messageBuildingBlock
xmi:id="_2pVhqWmEEeS7iYydEtv3Ug"
nextVersions="_5M7M6Y3FEeWjkqXgn_0Imw"
previousVersion="_jRTiBzSeEeOnFuyVSIQZKg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_PwIbYWmPEeS7iYydEtv3Ug" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="011"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.