caaa.010.001.03
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 %% AcceptorReconciliationResponseV03 recursion level 0 with max 0 AcceptorReconciliationResponseV03 *-- "1..1" Header7 : Header AcceptorReconciliationResponseV03 *-- "1..1" AcceptorReconciliationResponse2 : ReconciliationResponse AcceptorReconciliationResponseV03 *-- "1..1" ContentInformationType8 : 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 %% Header7 recursion level 0 with max 1 class Header7{ MessageFunction MessageFunction4Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoMax3NumericText CreationDateTime IsoISODateTime } Header7 *-- "1..1" GenericIdentification32 : InitiatingParty Header7 *-- "0..1" GenericIdentification32 : RecipientParty Header7 *-- "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
Header7 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | MessageFunction4Code - 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 %% ContentInformationType8 recursion level 0 with max 1 class ContentInformationType8{ ContentType ContentType1Code } ContentInformationType8 *-- "0..0" AuthenticatedData3 : AuthenticatedData %% AuthenticatedData3 recursion level 1 with max 1 class AuthenticatedData3{ Version IsoNumber MAC IsoMax35Binary } AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent
ContentInformationType8 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). | AuthenticatedData3 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorReconciliationResponseV03 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationResponseV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationResponseV03Document implements IOuterDocument. Because AcceptorReconciliationResponseV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationResponseV03.
classDiagram class IOuterRecord AcceptorReconciliationResponseV03 --|> IOuterRecord : Implements AcceptorReconciliationResponseV03Document --|> IOuterDocument~AcceptorReconciliationResponseV03~ : Implements class IOuterDocument~AcceptorReconciliationResponseV03~ { AcceptorReconciliationResponseV03 Message }
Document wrapper for serialization
The only real purpose AcceptorReconciliationResponseV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.010.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationResponseV03.ToDocument() method. The returned AcceptorReconciliationResponseV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorReconciliationResponseV03Document *-- AcceptorReconciliationResponseV03 : 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.03">
<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="_1dGI8TJtEeOQDoPKFK41HQ"
nextVersions="_lHle8WmAEeSxgrJ0GX4SQQ"
previousVersion="_3gM8MQvgEeK9Xewg3qiFQA"
name="AcceptorReconciliationResponseV03"
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">
<doclet
xmi:id="_1os8ADJtEeOQDoPKFK41HQ"
type="purpose" />
<messageBuildingBlock
xmi:id="_1dGI8zJtEeOQDoPKFK41HQ"
nextVersions="_lHmGA2mAEeSxgrJ0GX4SQQ"
previousVersion="_3gM8MwvgEeK9Xewg3qiFQA"
name="Header"
definition="Reconciliation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UNSh8S9IEeOlZIh7PImd0A" />
<messageBuildingBlock
xmi:id="_1dGI9TJtEeOQDoPKFK41HQ"
nextVersions="_lHmGBWmAEeSxgrJ0GX4SQQ"
previousVersion="_3gM8NwvgEeK9Xewg3qiFQA"
name="ReconciliationResponse"
definition="Information related to thereconciliation response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnRspn"
complexType="_cch-sRzwEeK5OKMB21JFBg" />
<messageBuildingBlock
xmi:id="_1dGI9zJtEeOQDoPKFK41HQ"
nextVersions="_lHmGB2mAEeSxgrJ0GX4SQQ"
previousVersion="_3gM8OwvgEeK9Xewg3qiFQA"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_KpedcTF5EeO118ZQJgaQSQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="010"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.