AcceptorBatchTransferResponseV03

caaa.012.001.03

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
%% AcceptorBatchTransferResponseV03 recursion level 0 with max 0
AcceptorBatchTransferResponseV03 *-- "1..1" Header3 : Header
AcceptorBatchTransferResponseV03 *-- "1..1" CardPaymentBatchTransferResponse2 : BatchTransferResponse
AcceptorBatchTransferResponseV03 *-- "1..1" ContentInformationType9 : 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

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
%% CardPaymentBatchTransferResponse2 recursion level 0 with max 1
CardPaymentBatchTransferResponse2 *-- "0..0" TransactionTotals2 : TransactionTotals
CardPaymentBatchTransferResponse2 *-- "0..0" CardPaymentDataSet9 : DataSet
%% TransactionTotals2 recursion level 1 with max 1
class TransactionTotals2{
    POIGroupIdentification IsoMax35Text
    CardProductProfile IsoExact4NumericText
    Currency CurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoMax35NumericText
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet9 recursion level 1 with max 1
class CardPaymentDataSet9{
    RemoveDataSet IsoTrueFalseIndicator
}
CardPaymentDataSet9 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet9 *-- "1..1" ResponseType1 : DataSetResult
CardPaymentDataSet9 *-- "0..1" GenericIdentification32 : DataSetInitiator
CardPaymentDataSet9 *-- "1..0" TransactionTotals2 : TransactionTotals
CardPaymentDataSet9 *-- "0..0" CardPaymentDataSet8 : RejectedTransaction
  

CardPaymentBatchTransferResponse2 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferResponseV03 --|> IOuterRecord : Implements
    AcceptorBatchTransferResponseV03Document --|> IOuterDocument~AcceptorBatchTransferResponseV03~ : Implements
    class IOuterDocument~AcceptorBatchTransferResponseV03~ {
        AcceptorBatchTransferResponseV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferResponseV03Document *-- AcceptorBatchTransferResponseV03 : 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.03">
    <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="_tye6YTShEeOnFuyVSIQZKg"
  nextVersions="_kicoMWmZEeSQ1udc47rf0A"
  previousVersion="_rS2OgQvgEeK9Xewg3qiFQA"
  name="AcceptorBatchTransferResponseV03"
  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">
  <doclet
    xmi:id="_t9yygDShEeOnFuyVSIQZKg"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_tye6YzShEeOnFuyVSIQZKg"
    nextVersions="_kidPQ2mZEeSQ1udc47rf0A"
    previousVersion="_rS2OgwvgEeK9Xewg3qiFQA"
    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="_tye6ZTShEeOnFuyVSIQZKg"
    nextVersions="_kidPRWmZEeSQ1udc47rf0A"
    previousVersion="_Og4Y8C8UEeKW5usMQLtzqw"
    name="BatchTransferResponse"
    definition="Information related to the previously sent set of transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrfRspn"
    complexType="_cwQvgTShEeOnFuyVSIQZKg" />
  <messageBuildingBlock
    xmi:id="_tye6ZzShEeOnFuyVSIQZKg"
    nextVersions="_kidPR2mZEeSQ1udc47rf0A"
    previousVersion="_rS2OiwvgEeK9Xewg3qiFQA"
    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="012"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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