caaa.011.001.01
Scope The AcceptorBatchTransfer message is sent by the card acceptor to the acquirer to capture a collection of previously completed card payment transactions. Usage The AcceptorBatchTransfer message embeds the information required for transferring to the acquirer the data needed to perform the financial settlement of these transactions (capture).
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
%% AcceptorBatchTransferV01 recursion level 0 with max 0
AcceptorBatchTransferV01 *-- "1..1" Header3 : Header
AcceptorBatchTransferV01 *-- "1..1" CardPaymentDataSet1 : DataSet
AcceptorBatchTransferV01 *-- "1..1" ContentInformationType1 : 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 |
DataSet building block
Information related to the set of transaction. Set of transactions to capture, sharing common characteristics. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CardPaymentDataSet1 recursion level 0 with max 1
CardPaymentDataSet1 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet1 *-- "0..0" Traceability1 : Traceability
CardPaymentDataSet1 *-- "0..1" GenericIdentification32 : DataSetInitiator
CardPaymentDataSet1 *-- "1..0" TransactionTotals1 : TransactionTotals
CardPaymentDataSet1 *-- "0..1" CommonData1 : CommonData
CardPaymentDataSet1 *-- "0..0" CardPaymentDataSetTransaction1 : TransactionToCapture
%% DataSetIdentification1 recursion level 1 with max 1
class DataSetIdentification1{
Name IsoMax256Text
Type DataSetCategory1Code
Version IsoMax256Text
CreationDateTime IsoISODateTime
}
%% Traceability1 recursion level 1 with max 1
class Traceability1{
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability1 *-- "1..1" GenericIdentification31 : RelayIdentification
%% GenericIdentification32 recursion level 1 with max 1
class GenericIdentification32{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
ShortName IsoMax35Text
}
%% TransactionTotals1 recursion level 1 with max 1
class TransactionTotals1{
POIGroupIdentification IsoMax35Text
CardProductProfile IsoExact4NumericText
Currency CurrencyCode
Type TypeTransactionTotals1Code
TotalNumber IsoMax35NumericText
CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CommonData1 recursion level 1 with max 1
class CommonData1{
TransactionType CardPaymentServiceType1Code
AdditionalService CardPaymentServiceType2Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
ReconciliationIdentification IsoMax35Text
Currency CurrencyCode
}
CommonData1 *-- "0..1" CardPaymentEnvironment5 : Environment
CommonData1 *-- "0..1" CardPaymentContext3 : Context
%% CardPaymentDataSetTransaction1 recursion level 1 with max 1
class CardPaymentDataSetTransaction1{
TransactionSequenceCounter IsoMax9NumericText
}
CardPaymentDataSetTransaction1 *-- "0..0" Traceability1 : Traceability
CardPaymentDataSetTransaction1 *-- "1..1" CardPaymentEnvironment6 : Environment
CardPaymentDataSetTransaction1 *-- "0..1" CardPaymentContext3 : Context
CardPaymentDataSetTransaction1 *-- "1..1" CardPaymentTransaction4 : Transaction
CardPaymentDataSet1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| DataSetIdentification | Identification of the data set. | DataSetIdentification1 - Required 1..1 |
| Traceability | Identification of partners involved in the data set building. | Traceability1 - Unknown 0..0 |
| DataSetInitiator | Initiator of the data set. | GenericIdentification32 - Optional 0..1 |
| TransactionTotals | Transaction totals of the data set. | TransactionTotals1 - Unknown 1..0 |
| CommonData | Data common to all transactions of the data set. | CommonData1 - Optional 0..1 |
| TransactionToCapture | Set of transaction to capture. | CardPaymentDataSetTransaction1 - 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
%% ContentInformationType1 recursion level 0 with max 1
class ContentInformationType1{
ContentType ContentType1Code
}
ContentInformationType1 *-- "0..1" EnvelopedData1 : EnvelopedData
ContentInformationType1 *-- "0..1" AuthenticatedData1 : AuthenticatedData
ContentInformationType1 *-- "0..1" SignedData1 : SignedData
ContentInformationType1 *-- "0..1" DigestedData1 : DigestedData
ContentInformationType1 *-- "0..1" NamedKeyEncryptedData1 : NamedKeyEncryptedData
%% EnvelopedData1 recursion level 1 with max 1
class EnvelopedData1{
Version IsoNumber
}
EnvelopedData1 *-- "1..0" IRecipient1Choice : Recipient
EnvelopedData1 *-- "1..1" EncryptedContent1 : EncryptedContent
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% SignedData1 recursion level 1 with max 1
class SignedData1{
Version IsoNumber
Certificate IsoMax3000Binary
}
SignedData1 *-- "1..0" AlgorithmIdentification1 : DigestAlgorithm
SignedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
SignedData1 *-- "1..0" Signer1 : Signer
%% DigestedData1 recursion level 1 with max 1
class DigestedData1{
Version IsoNumber
Digest IsoMax140Text
}
DigestedData1 *-- "1..0" AlgorithmIdentification1 : DigestAlgorithm
DigestedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% NamedKeyEncryptedData1 recursion level 1 with max 1
class NamedKeyEncryptedData1{
Version IsoNumber
KeyName IsoMax140Text
}
NamedKeyEncryptedData1 *-- "1..1" EncryptedContent1 : EncryptedContent
ContentInformationType1 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. | EnvelopedData1 - Optional 0..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData1 - Optional 0..1 |
| SignedData | Data protected by digital signatures. | SignedData1 - Optional 0..1 |
| DigestedData | Data protected by a digest. | DigestedData1 - Optional 0..1 |
| NamedKeyEncryptedData | Data protection by encryption with a previously exchanged key identified by a name. | NamedKeyEncryptedData1 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorBatchTransferV01 implementation follows a specific implementaiton pattern. First of all, AcceptorBatchTransferV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorBatchTransferV01Document implements IOuterDocument. Because AcceptorBatchTransferV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorBatchTransferV01.
classDiagram
class IOuterRecord
AcceptorBatchTransferV01 --|> IOuterRecord : Implements
AcceptorBatchTransferV01Document --|> IOuterDocument~AcceptorBatchTransferV01~ : Implements
class IOuterDocument~AcceptorBatchTransferV01~ {
AcceptorBatchTransferV01 Message
}
Document wrapper for serialization
The only real purpose AcceptorBatchTransferV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.011.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorBatchTransferV01.ToDocument() method. The returned AcceptorBatchTransferV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorBatchTransferV01Document *-- AcceptorBatchTransferV01 : 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.01">
<AccptrBtchTrf>
<Hdr>
<!-- Header inner content -->
</Hdr>
<DataSet>
<!-- DataSet inner content -->
</DataSet>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrBtchTrf>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_edEQpaMVEeCJ6YNENx4h-w_1105979751"
nextVersions="_iog7oQvgEeK9Xewg3qiFQA"
name="AcceptorBatchTransferV01"
definition="Scope
The AcceptorBatchTransfer message is sent by the card acceptor to the acquirer to capture a collection of previously completed card payment transactions.
Usage
The AcceptorBatchTransfer message embeds the information required for transferring to the acquirer the data needed to perform the financial settlement of these transactions (capture)."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrBtchTrf"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_edEQpqMVEeCJ6YNENx4h-w_-1485321403"
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="_edEQp6MVEeCJ6YNENx4h-w_1311812770"
name="DataSet"
definition="Information related to the set of transaction."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="DataSet"
complexType="_TDm_yAEcEeCQm6a_G2yO_w_158061117" />
<messageBuildingBlock
xmi:id="_edEQqKMVEeCJ6YNENx4h-w_-1725019093"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_SwFm2gEcEeCQm6a_G2yO_w_1341928510" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="011"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.