AcceptorBatchTransferResponseV10

caaa.012.001.10

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
%% AcceptorBatchTransferResponseV10 recursion level 0 with max 0
AcceptorBatchTransferResponseV10 *-- "1..1" Header56 : Header
AcceptorBatchTransferResponseV10 *-- "1..1" CardPaymentBatchTransferResponse9 : BatchTransferResponse
AcceptorBatchTransferResponseV10 *-- "0..1" ContentInformationType31 : 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
%% Header56 recursion level 0 with max 1
class Header56{
    DownloadTransfer IsoTrueFalseIndicator
    FormatVersion IsoMax6Text
    ExchangeIdentification IsoNumber
    CreationDateTime IsoISODateTime
}
Header56 *-- "1..1" GenericIdentification176 : InitiatingParty
Header56 *-- "0..1" GenericIdentification177 : RecipientParty
%% GenericIdentification176 recursion level 1 with max 1
class GenericIdentification176{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification177 recursion level 1 with max 1
class GenericIdentification177{
    Identification IsoMax35Text
    Type PartyType33Code
    Issuer PartyType33Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess
GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation
  

Header56 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
%% CardPaymentBatchTransferResponse9 recursion level 0 with max 1
CardPaymentBatchTransferResponse9 *-- "0..0" TransactionTotals12 : TransactionTotals
CardPaymentBatchTransferResponse9 *-- "0..0" CardPaymentDataSet31 : DataSet
%% TransactionTotals12 recursion level 1 with max 1
class TransactionTotals12{
    POIGroupIdentification IsoMax35Text
    CardBrand IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency ActiveCurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet31 recursion level 1 with max 1
class CardPaymentDataSet31{
    RemoveDataSet IsoTrueFalseIndicator
}
CardPaymentDataSet31 *-- "1..1" DataSetIdentification5 : DataSetIdentification
CardPaymentDataSet31 *-- "1..1" ResponseType10 : DataSetResult
CardPaymentDataSet31 *-- "0..1" GenericIdentification176 : DataSetInitiator
CardPaymentDataSet31 *-- "1..0" TransactionTotals12 : TransactionTotals
CardPaymentDataSet31 *-- "0..0" CardPaymentDataSet30 : RejectedTransaction
CardPaymentDataSet31 *-- "0..0" CardPaymentDataSet30 : SuspendedTransaction
CardPaymentDataSet31 *-- "0..0" CardPaymentDataSet30 : ResumedApproval
CardPaymentDataSet31 *-- "0..0" CardPaymentDataSet30 : ResumedRejection
  

CardPaymentBatchTransferResponse9 members

SecurityTrailer building block

Trailer of the message containing a MAC or a digital signature. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContentInformationType31 recursion level 0 with max 1
class ContentInformationType31{
    ContentType ContentType2Code
}
ContentInformationType31 *-- "1..1" AuthenticatedData8 : AuthenticatedData
%% AuthenticatedData8 recursion level 1 with max 1
class AuthenticatedData8{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData8 *-- "1..0" IRecipient11Choice : Recipient
AuthenticatedData8 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData8 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
  

ContentInformationType31 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferResponseV10 --|> IOuterRecord : Implements
    AcceptorBatchTransferResponseV10Document --|> IOuterDocument~AcceptorBatchTransferResponseV10~ : Implements
    class IOuterDocument~AcceptorBatchTransferResponseV10~ {
        AcceptorBatchTransferResponseV10 Message
     }
  

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferResponseV10Document *-- AcceptorBatchTransferResponseV10 : 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.10">
    <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="_r0TgUVFGEeyApZmLzm74zA"
  nextVersions="_dV1G0XMYEe2vXY6MoVq19w"
  previousVersion="_CnF1sS4-EeunNvJlR_vCbg"
  name="AcceptorBatchTransferResponseV10"
  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="_fMW_EL1vEeKoB-JG4saAMg_-385897474"
  xmlTag="AccptrBtchTrfRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_r0TgU1FGEeyApZmLzm74zA"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_r0TgVVFGEeyApZmLzm74zA"
    nextVersions="_dV1G1XMYEe2vXY6MoVq19w"
    previousVersion="_CnF1tS4-EeunNvJlR_vCbg"
    name="Header"
    definition="Capture advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_E0yzQQt-EeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_r0TgV1FGEeyApZmLzm74zA"
    nextVersions="_dV1G13MYEe2vXY6MoVq19w"
    previousVersion="_CnF1ty4-EeunNvJlR_vCbg"
    name="BatchTransferResponse"
    definition="Information related to the previously sent set of transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrfRspn"
    complexType="_g8HvYVICEey4xOoMoOPSJQ" />
  <messageBuildingBlock
    xmi:id="_r0TgWVFGEeyApZmLzm74zA"
    nextVersions="_dV1G2XMYEe2vXY6MoVq19w"
    previousVersion="_CnF1uS4-EeunNvJlR_vCbg"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_dJxbAVFFEeyApZmLzm74zA" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="012"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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