caaa.009.001.02
The AcceptorReconciliationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to ensure that the debits and credits performed by the acceptor matches the computed balances of the acquirer for the debits and credits performed during the same reconciliation period. If the acceptor or the acquirer notices a difference in totals, the discrepancy will be resolved by other means, outside the scope of the protocol.
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 %% AcceptorReconciliationRequestV02 recursion level 0 with max 0 AcceptorReconciliationRequestV02 *-- "1..1" Header1 : Header AcceptorReconciliationRequestV02 *-- "1..1" AcceptorReconciliationRequest2 : ReconciliationRequest AcceptorReconciliationRequestV02 *-- "1..1" ContentInformationType6 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Reconciliation request message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Header1 recursion level 0 with max 1 class Header1{ MessageFunction MessageFunction1Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoMax3NumericText CreationDateTime IsoISODateTime } Header1 *-- "1..1" GenericIdentification32 : InitiatingParty Header1 *-- "0..1" GenericIdentification32 : RecipientParty Header1 *-- "0..0" Traceability1 : Traceability %% 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 } %% Traceability1 recursion level 1 with max 1 class Traceability1{ TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability1 *-- "1..1" GenericIdentification31 : RelayIdentification
Header1 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | MessageFunction1Code - Required 1..1 |
ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
ExchangeIdentification | Unique identification of an exchange occurrence. | IsoMax3NumericText - Required 1..1 |
CreationDateTime | Date and time at which the 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 message exchange. | GenericIdentification32 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability1 - Unknown 0..0 |
ReconciliationRequest building block
Information related to the reconcilliation request. Reconciliation request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorReconciliationRequest2 recursion level 0 with max 1 AcceptorReconciliationRequest2 *-- "1..1" CardPaymentEnvironment15 : Environment AcceptorReconciliationRequest2 *-- "1..1" TransactionReconciliation2 : Transaction %% CardPaymentEnvironment15 recursion level 1 with max 1 CardPaymentEnvironment15 *-- "1..1" Acquirer2 : Acquirer CardPaymentEnvironment15 *-- "0..1" GenericIdentification32 : MerchantIdentification CardPaymentEnvironment15 *-- "0..1" GenericIdentification32 : POIIdentification %% TransactionReconciliation2 recursion level 1 with max 1 class TransactionReconciliation2{ ClosePeriod IsoTrueFalseIndicator ReconciliationIdentification IsoMax35Text AdditionalTransactionData IsoMax70Text } TransactionReconciliation2 *-- "1..1" TransactionIdentifier1 : ReconciliationTransactionIdentification TransactionReconciliation2 *-- "0..0" TransactionTotals2 : TransactionTotals
AcceptorReconciliationRequest2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Environment | Environment of the transaction. | CardPaymentEnvironment15 - Required 1..1 |
Transaction | Reconciliation transaction between an acceptor an acquirer. | TransactionReconciliation2 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC. General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ContentInformationType6 recursion level 0 with max 1 class ContentInformationType6{ ContentType ContentType1Code } ContentInformationType6 *-- "0..0" AuthenticatedData2 : AuthenticatedData %% 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
ContentInformationType6 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
ContentType | Type of data protection. | ContentType1Code - Required 1..1 |
AuthenticatedData | Data protection by a message authentication code (MAC). | AuthenticatedData2 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorReconciliationRequestV02 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationRequestV02Document implements IOuterDocument. Because AcceptorReconciliationRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationRequestV02.
classDiagram class IOuterRecord AcceptorReconciliationRequestV02 --|> IOuterRecord : Implements AcceptorReconciliationRequestV02Document --|> IOuterDocument~AcceptorReconciliationRequestV02~ : Implements class IOuterDocument~AcceptorReconciliationRequestV02~ { AcceptorReconciliationRequestV02 Message }
Document wrapper for serialization
The only real purpose AcceptorReconciliationRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.009.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationRequestV02.ToDocument() method. The returned AcceptorReconciliationRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorReconciliationRequestV02Document *-- AcceptorReconciliationRequestV02 : 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.009.001.02">
<AccptrRcncltnReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RcncltnReq>
<!-- ReconciliationRequest inner content -->
</RcncltnReq>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrRcncltnReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_y9gNEQvgEeK9Xewg3qiFQA"
nextVersions="_jktAgTJsEeOQDoPKFK41HQ"
previousVersion="_PNo5FaMVEeCJ6YNENx4h-w_-594784238"
name="AcceptorReconciliationRequestV02"
definition="The AcceptorReconciliationRequest message is sent by an acceptor (or its agent) to the acquirer (or its agent), to ensure that the debits and credits performed by the acceptor matches the computed balances of the acquirer for the debits and credits performed during the same reconciliation period.
If the acceptor or the acquirer notices a difference in totals, the discrepancy will be resolved by other means, outside the scope of the protocol."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrRcncltnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_y9gNEwvgEeK9Xewg3qiFQA"
nextVersions="_jktAgzJsEeOQDoPKFK41HQ"
name="Header"
definition="Reconciliation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
<messageBuildingBlock
xmi:id="_y9gNFwvgEeK9Xewg3qiFQA"
nextVersions="_jktAhTJsEeOQDoPKFK41HQ"
name="ReconciliationRequest"
definition="Information related to the reconcilliation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnReq"
complexType="_XW3scRzwEeK5OKMB21JFBg" />
<messageBuildingBlock
xmi:id="_y9gNGwvgEeK9Xewg3qiFQA"
nextVersions="_jktAhzJsEeOQDoPKFK41HQ"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_6DM4sQvFEeKzJ69IWwzB9Q" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="009"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.