AcceptorBatchTransferResponseV04

caaa.012.001.04

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
%% AcceptorBatchTransferResponseV04 recursion level 0 with max 0
AcceptorBatchTransferResponseV04 *-- "1..1" Header12 : Header
AcceptorBatchTransferResponseV04 *-- "1..1" CardPaymentBatchTransferResponse3 : BatchTransferResponse
AcceptorBatchTransferResponseV04 *-- "1..1" ContentInformationType12 : 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
%% 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

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
%% CardPaymentBatchTransferResponse3 recursion level 0 with max 1
CardPaymentBatchTransferResponse3 *-- "0..0" TransactionTotals3 : TransactionTotals
CardPaymentBatchTransferResponse3 *-- "0..0" CardPaymentDataSet12 : DataSet
%% TransactionTotals3 recursion level 1 with max 1
class TransactionTotals3{
    POIGroupIdentification IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency CurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet12 recursion level 1 with max 1
class CardPaymentDataSet12{
    RemoveDataSet IsoTrueFalseIndicator
}
CardPaymentDataSet12 *-- "1..1" DataSetIdentification1 : DataSetIdentification
CardPaymentDataSet12 *-- "1..1" ResponseType1 : DataSetResult
CardPaymentDataSet12 *-- "0..1" GenericIdentification53 : DataSetInitiator
CardPaymentDataSet12 *-- "1..0" TransactionTotals3 : TransactionTotals
CardPaymentDataSet12 *-- "0..0" CardPaymentDataSet11 : RejectedTransaction
  

CardPaymentBatchTransferResponse3 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
%% 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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferResponseV04 --|> IOuterRecord : Implements
    AcceptorBatchTransferResponseV04Document --|> IOuterDocument~AcceptorBatchTransferResponseV04~ : Implements
    class IOuterDocument~AcceptorBatchTransferResponseV04~ {
        AcceptorBatchTransferResponseV04 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferResponseV04Document *-- AcceptorBatchTransferResponseV04 : 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.04">
    <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="_kicoMWmZEeSQ1udc47rf0A"
  nextVersions="_HmXZ0Y3VEeWjkqXgn_0Imw"
  previousVersion="_tye6YTShEeOnFuyVSIQZKg"
  name="AcceptorBatchTransferResponseV04"
  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="_kidPQWmZEeSQ1udc47rf0A"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_kidPQ2mZEeSQ1udc47rf0A"
    nextVersions="_HmXZ1Y3VEeWjkqXgn_0Imw"
    previousVersion="_tye6YzShEeOnFuyVSIQZKg"
    name="Header"
    definition="Capture advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_-uGCQWmEEeS7iYydEtv3Ug" />
  <messageBuildingBlock
    xmi:id="_kidPRWmZEeSQ1udc47rf0A"
    nextVersions="_HmXZ143VEeWjkqXgn_0Imw"
    previousVersion="_tye6ZTShEeOnFuyVSIQZKg"
    name="BatchTransferResponse"
    definition="Information related to the previously sent set of transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrfRspn"
    complexType="_wpOMwWmZEeSQ1udc47rf0A" />
  <messageBuildingBlock
    xmi:id="_kidPR2mZEeSQ1udc47rf0A"
    nextVersions="_HmXZ2Y3VEeWjkqXgn_0Imw"
    previousVersion="_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="_PwIbYWmPEeS7iYydEtv3Ug" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="012"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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