Iso20022

AcceptorBatchTransferResponseV09

caaa.012.001.09

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
%% AcceptorBatchTransferResponseV09 recursion level 0 with max 0
AcceptorBatchTransferResponseV09 *-- "1..1" Header56 : Header
AcceptorBatchTransferResponseV09 *-- "1..1" CardPaymentBatchTransferResponse8 : BatchTransferResponse
AcceptorBatchTransferResponseV09 *-- "0..1" ContentInformationType27 : 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

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. IsoNumber - 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. GenericIdentification176 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the exchange. GenericIdentification177 - 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
%% CardPaymentBatchTransferResponse8 recursion level 0 with max 1
CardPaymentBatchTransferResponse8 *-- "0..0" TransactionTotals12 : TransactionTotals
CardPaymentBatchTransferResponse8 *-- "0..0" CardPaymentDataSet27 : DataSet
%% TransactionTotals12 recursion level 1 with max 1
class TransactionTotals12{
    POIGroupIdentification IsoMax35Text
    CardBrand IsoMax35Text
    CardProductProfile IsoMax35Text
    Currency ActiveCurrencyCode
    Type TypeTransactionTotals2Code
    TotalNumber IsoNumber
    CumulativeAmount IsoImpliedCurrencyAndAmount
}
%% CardPaymentDataSet27 recursion level 1 with max 1
class CardPaymentDataSet27{
    RemoveDataSet IsoTrueFalseIndicator
}
CardPaymentDataSet27 *-- "1..1" DataSetIdentification5 : DataSetIdentification
CardPaymentDataSet27 *-- "1..1" ResponseType10 : DataSetResult
CardPaymentDataSet27 *-- "0..1" GenericIdentification176 : DataSetInitiator
CardPaymentDataSet27 *-- "1..0" TransactionTotals12 : TransactionTotals
CardPaymentDataSet27 *-- "0..0" CardPaymentDataSet28 : RejectedTransaction
CardPaymentDataSet27 *-- "0..0" CardPaymentDataSet28 : SuspendedTransaction
CardPaymentDataSet27 *-- "0..0" CardPaymentDataSet28 : ResumedApproval
CardPaymentDataSet27 *-- "0..0" CardPaymentDataSet28 : ResumedRejection

CardPaymentBatchTransferResponse8 members

Member name Description Data Type / Multiplicity
TransactionTotals Totals of transactions of all the data sets. TransactionTotals12 - Unknown 0..0
DataSet Information related to the previously sent set of transaction. CardPaymentDataSet27 - Unknown 0..0

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
%% ContentInformationType27 recursion level 0 with max 1
class ContentInformationType27{
    ContentType ContentType2Code
}
ContentInformationType27 *-- "1..1" AuthenticatedData7 : AuthenticatedData
%% AuthenticatedData7 recursion level 1 with max 1
class AuthenticatedData7{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient
AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType27 members

Member name Description Data Type / Multiplicity
ContentType Type of data protection. ContentType2Code - Required 1..1
AuthenticatedData Data protection by a message authentication code (MAC). AuthenticatedData7 - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorBatchTransferResponseV09 --|> IOuterRecord : Implements
    AcceptorBatchTransferResponseV09Document --|> IOuterDocument~AcceptorBatchTransferResponseV09~ : Implements
    class IOuterDocument~AcceptorBatchTransferResponseV09~ {
        AcceptorBatchTransferResponseV09 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorBatchTransferResponseV09Document *-- AcceptorBatchTransferResponseV09 : 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.09">
    <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="_CnF1sS4-EeunNvJlR_vCbg"
  nextVersions="_r0TgUVFGEeyApZmLzm74zA"
  previousVersion="_s260IQuZEeqYM5yH99IYQw"
  name="AcceptorBatchTransferResponseV09"
  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="_CnF1sy4-EeunNvJlR_vCbg"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_CnF1tS4-EeunNvJlR_vCbg"
    nextVersions="_r0TgVVFGEeyApZmLzm74zA"
    previousVersion="_s260JQuZEeqYM5yH99IYQw"
    name="Header"
    definition="Capture advice response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_E0yzQQt-EeqYM5yH99IYQw" />
  <messageBuildingBlock
    xmi:id="_CnF1ty4-EeunNvJlR_vCbg"
    nextVersions="_r0TgV1FGEeyApZmLzm74zA"
    previousVersion="_s260JwuZEeqYM5yH99IYQw"
    name="BatchTransferResponse"
    definition="Information related to the previously sent set of transaction."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="BtchTrfRspn"
    complexType="_WM2JwS49EeunNvJlR_vCbg" />
  <messageBuildingBlock
    xmi:id="_CnF1uS4-EeunNvJlR_vCbg"
    nextVersions="_r0TgWVFGEeyApZmLzm74zA"
    previousVersion="_s260KQuZEeqYM5yH99IYQw"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC or a digital signature."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_2S4usS8lEeu125Ip9zFcsQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="012"
    flavour="001"
    version="09" />
</messageDefinition>

ISO Building Blocks

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