caaa.012.001.02
The AcceptorBatchTransferResponse is sent by the acquirer (or its agent) to inform the acceptor (or its agent) of the transfer in a previous AcceptorBatchTransfer of a collection of transactions.
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
%% AcceptorBatchTransferResponseV02 recursion level 0 with max 0
AcceptorBatchTransferResponseV02 *-- "1..1" Header3 : Header
AcceptorBatchTransferResponseV02 *-- "1..1" CardPaymentBatchTransferResponse1 : BatchTransferResponse
AcceptorBatchTransferResponseV02 *-- "1..1" ContentInformationType4 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Capture advice response 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 |
BatchTransferResponse building block
Information related to the previously sent set of transaction. Status of the transactions sent in a previous batch of card payment transactions. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CardPaymentBatchTransferResponse1 recursion level 0 with max 1
CardPaymentBatchTransferResponse1 *-- "1..1" TransactionTotals2 : TransactionTotals
CardPaymentBatchTransferResponse1 *-- "0..0" CardPaymentDataSet5 : DataSet
%% TransactionTotals2 recursion level 1 with max 1
class TransactionTotals2{
POIGroupIdentification IsoMax35Text
CardProductProfile IsoExact4NumericText
Currency CurrencyCode
Type TypeTransactionTotals2Code
TotalNumber IsoMax35NumericText
CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet5 recursion level 1 with max 1
class CardPaymentDataSet5{
RemoveDataSet IsoTrueFalseIndicator
}
CardPaymentDataSet5 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet5 *-- "1..1" ResponseType1 : DataSetResult
CardPaymentDataSet5 *-- "0..1" GenericIdentification32 : DataSetInitiator
CardPaymentDataSet5 *-- "1..0" TransactionTotals2 : TransactionTotals
CardPaymentDataSet5 *-- "0..0" CardPaymentDataSet6 : RejectedTransaction
CardPaymentBatchTransferResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| TransactionTotals | Totals of transactions of all the data sets. | TransactionTotals2 - Required 1..1 |
| DataSet | Information related to the previously sent set of transaction. | CardPaymentDataSet5 - 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
%% ContentInformationType4 recursion level 0 with max 1
class ContentInformationType4{
ContentType ContentType1Code
}
ContentInformationType4 *-- "0..1" EnvelopedData2 : EnvelopedData
ContentInformationType4 *-- "0..1" AuthenticatedData2 : AuthenticatedData
ContentInformationType4 *-- "0..1" SignedData2 : SignedData
ContentInformationType4 *-- "0..1" DigestedData2 : DigestedData
ContentInformationType4 *-- "0..1" NamedKeyEncryptedData2 : NamedKeyEncryptedData
%% EnvelopedData2 recursion level 1 with max 1
class EnvelopedData2{
Version IsoNumber
}
EnvelopedData2 *-- "1..0" IRecipient2Choice : Recipient
EnvelopedData2 *-- "1..1" EncryptedContent2 : EncryptedContent
%% AuthenticatedData2 recursion level 1 with max 1
class AuthenticatedData2{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData2 *-- "1..0" IRecipient2Choice : Recipient
AuthenticatedData2 *-- "1..1" AlgorithmIdentification3 : MACAlgorithm
AuthenticatedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% SignedData2 recursion level 1 with max 1
class SignedData2{
Version IsoNumber
Certificate IsoMax3000Binary
}
SignedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
SignedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
SignedData2 *-- "1..0" Signer2 : Signer
%% DigestedData2 recursion level 1 with max 1
class DigestedData2{
Version IsoNumber
Digest IsoMax140Text
}
DigestedData2 *-- "1..0" AlgorithmIdentification5 : DigestAlgorithm
DigestedData2 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
%% NamedKeyEncryptedData2 recursion level 1 with max 1
class NamedKeyEncryptedData2{
Version IsoNumber
KeyName IsoMax140Text
}
NamedKeyEncryptedData2 *-- "1..1" EncryptedContent2 : EncryptedContent
ContentInformationType4 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. | EnvelopedData2 - Optional 0..1 |
| AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData2 - Optional 0..1 |
| SignedData | Data protected by digital signatures. | SignedData2 - Optional 0..1 |
| DigestedData | Data protected by a digest. | DigestedData2 - Optional 0..1 |
| NamedKeyEncryptedData | Data protection by encryption with a previously exchanged key identified by a name. | NamedKeyEncryptedData2 - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorBatchTransferResponseV02 implementation follows a specific implementaiton pattern. First of all, AcceptorBatchTransferResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorBatchTransferResponseV02Document implements IOuterDocument. Because AcceptorBatchTransferResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorBatchTransferResponseV02.
classDiagram
class IOuterRecord
AcceptorBatchTransferResponseV02 --|> IOuterRecord : Implements
AcceptorBatchTransferResponseV02Document --|> IOuterDocument~AcceptorBatchTransferResponseV02~ : Implements
class IOuterDocument~AcceptorBatchTransferResponseV02~ {
AcceptorBatchTransferResponseV02 Message
}
Document wrapper for serialization
The only real purpose AcceptorBatchTransferResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.012.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorBatchTransferResponseV02.ToDocument() method. The returned AcceptorBatchTransferResponseV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorBatchTransferResponseV02Document *-- AcceptorBatchTransferResponseV02 : 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.012.001.02">
<AccptrBtchTrfRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<BtchTrfRspn>
<!-- BatchTransferResponse inner content -->
</BtchTrfRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrBtchTrfRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rS2OgQvgEeK9Xewg3qiFQA"
nextVersions="_tye6YTShEeOnFuyVSIQZKg"
previousVersion="_fHr69KMVEeCJ6YNENx4h-w_-1884462176"
name="AcceptorBatchTransferResponseV02"
definition="The AcceptorBatchTransferResponse is sent by the acquirer (or its agent) to inform the acceptor (or its agent) of the transfer in a previous AcceptorBatchTransfer of a collection of transactions."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrBtchTrfRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_rS2OgwvgEeK9Xewg3qiFQA"
nextVersions="_tye6YzShEeOnFuyVSIQZKg"
name="Header"
definition="Capture advice response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SwPX0wEcEeCQm6a_G2yO_w_-1399456836" />
<messageBuildingBlock
xmi:id="_Og4Y8C8UEeKW5usMQLtzqw"
nextVersions="_tye6ZTShEeOnFuyVSIQZKg"
name="BatchTransferResponse"
definition="Information related to the previously sent set of transaction."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="BtchTrfRspn"
complexType="_E2LswC45EeKIarvwWcPThw" />
<messageBuildingBlock
xmi:id="_rS2OiwvgEeK9Xewg3qiFQA"
nextVersions="_tye6ZzShEeOnFuyVSIQZKg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC or a digital signature."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_lLfC8QvFEeKzJ69IWwzB9Q" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="012"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.