caaa.010.001.02
The AcceptorReconciliationResponse message is sent by the acquirer (or its agent) to an acceptor (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 %% AcceptorReconciliationResponseV02 recursion level 0 with max 0 AcceptorReconciliationResponseV02 *-- "1..1" Header1 : Header AcceptorReconciliationResponseV02 *-- "1..1" AcceptorReconciliationResponse2 : ReconciliationResponse AcceptorReconciliationResponseV02 *-- "1..1" ContentInformationType6 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Reconciliation response 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 |
ReconciliationResponse building block
Information related to thereconciliation response. Reconciliation response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorReconciliationResponse2 recursion level 0 with max 1 AcceptorReconciliationResponse2 *-- "1..1" CardPaymentEnvironment19 : Environment AcceptorReconciliationResponse2 *-- "1..1" ResponseType1 : TransactionResponse AcceptorReconciliationResponse2 *-- "1..1" TransactionReconciliation2 : Transaction %% CardPaymentEnvironment19 recursion level 1 with max 1 CardPaymentEnvironment19 *-- "1..1" GenericIdentification32 : AcquirerIdentification CardPaymentEnvironment19 *-- "0..1" GenericIdentification32 : MerchantIdentification CardPaymentEnvironment19 *-- "0..1" GenericIdentification32 : POIIdentification %% ResponseType1 recursion level 1 with max 1 class ResponseType1{ Response Response1Code ResponseReason IsoMax35Text } %% 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
AcceptorReconciliationResponse2 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Environment | Environment of the transaction. | CardPaymentEnvironment19 - Required 1..1 |
TransactionResponse | Response from the acquirer to the reconciliation transaction. | ResponseType1 - 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 AcceptorReconciliationResponseV02 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationResponseV02Document implements IOuterDocument. Because AcceptorReconciliationResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationResponseV02.
classDiagram class IOuterRecord AcceptorReconciliationResponseV02 --|> IOuterRecord : Implements AcceptorReconciliationResponseV02Document --|> IOuterDocument~AcceptorReconciliationResponseV02~ : Implements class IOuterDocument~AcceptorReconciliationResponseV02~ { AcceptorReconciliationResponseV02 Message }
Document wrapper for serialization
The only real purpose AcceptorReconciliationResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.010.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationResponseV02.ToDocument() method. The returned AcceptorReconciliationResponseV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorReconciliationResponseV02Document *-- AcceptorReconciliationResponseV02 : 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.010.001.02">
<AccptrRcncltnRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<RcncltnRspn>
<!-- ReconciliationResponse inner content -->
</RcncltnRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrRcncltnRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_3gM8MQvgEeK9Xewg3qiFQA"
nextVersions="_1dGI8TJtEeOQDoPKFK41HQ"
previousVersion="_OV5_1aMVEeCJ6YNENx4h-w_2086001955"
name="AcceptorReconciliationResponseV02"
definition="The AcceptorReconciliationResponse message is sent by the acquirer (or its agent) to an acceptor (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="AccptrRcncltnRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_3gM8MwvgEeK9Xewg3qiFQA"
nextVersions="_1dGI8zJtEeOQDoPKFK41HQ"
name="Header"
definition="Reconciliation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_SvV__wEcEeCQm6a_G2yO_w_677025486" />
<messageBuildingBlock
xmi:id="_3gM8NwvgEeK9Xewg3qiFQA"
nextVersions="_1dGI9TJtEeOQDoPKFK41HQ"
name="ReconciliationResponse"
definition="Information related to thereconciliation response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnRspn"
complexType="_cch-sRzwEeK5OKMB21JFBg" />
<messageBuildingBlock
xmi:id="_3gM8OwvgEeK9Xewg3qiFQA"
nextVersions="_1dGI9zJtEeOQDoPKFK41HQ"
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="010"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.