caaa.010.001.04
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 %% AcceptorReconciliationResponseV04 recursion level 0 with max 0 AcceptorReconciliationResponseV04 *-- "1..1" Header10 : Header AcceptorReconciliationResponseV04 *-- "1..1" AcceptorReconciliationResponse3 : ReconciliationResponse AcceptorReconciliationResponseV04 *-- "1..1" ContentInformationType11 : 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 %% Header10 recursion level 0 with max 1 class Header10{ MessageFunction MessageFunction4Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoMax3NumericText CreationDateTime IsoISODateTime } Header10 *-- "1..1" GenericIdentification53 : InitiatingParty Header10 *-- "0..1" GenericIdentification53 : RecipientParty Header10 *-- "0..0" Traceability2 : Traceability %% GenericIdentification53 recursion level 1 with max 1 class GenericIdentification53{ Identification IsoMax35Text Type PartyType3Code Issuer PartyType4Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% GenericIdentification53 recursion level 1 with max 1 class GenericIdentification53{ Identification IsoMax35Text Type PartyType3Code Issuer PartyType4Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% Traceability2 recursion level 1 with max 1 class Traceability2{ TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification
Header10 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. | GenericIdentification53 - Required 1..1 |
RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification53 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability2 - Unknown 0..0 |
ReconciliationResponse building block
Information related to the reconciliation response. Reconciliation response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorReconciliationResponse3 recursion level 0 with max 1 AcceptorReconciliationResponse3 *-- "1..1" CardPaymentEnvironment38 : Environment AcceptorReconciliationResponse3 *-- "1..1" ResponseType1 : TransactionResponse AcceptorReconciliationResponse3 *-- "1..1" TransactionReconciliation3 : Transaction %% CardPaymentEnvironment38 recursion level 1 with max 1 CardPaymentEnvironment38 *-- "1..1" GenericIdentification53 : AcquirerIdentification CardPaymentEnvironment38 *-- "0..1" GenericIdentification32 : MerchantIdentification CardPaymentEnvironment38 *-- "0..1" GenericIdentification32 : POIIdentification %% ResponseType1 recursion level 1 with max 1 class ResponseType1{ Response Response1Code ResponseReason IsoMax35Text } %% TransactionReconciliation3 recursion level 1 with max 1 class TransactionReconciliation3{ ClosePeriod IsoTrueFalseIndicator ReconciliationIdentification IsoMax35Text AdditionalTransactionData IsoMax70Text } TransactionReconciliation3 *-- "1..1" TransactionIdentifier1 : ReconciliationTransactionIdentification TransactionReconciliation3 *-- "0..0" TransactionTotals3 : TransactionTotals
AcceptorReconciliationResponse3 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Environment | Environment of the transaction. | CardPaymentEnvironment38 - Required 1..1 |
TransactionResponse | Response from the acquirer to the reconciliation transaction. | ResponseType1 - Required 1..1 |
Transaction | Reconciliation transaction between an acceptor an acquirer. | TransactionReconciliation3 - 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 %% ContentInformationType11 recursion level 0 with max 1 class ContentInformationType11{ ContentType ContentType2Code } ContentInformationType11 *-- "0..0" AuthenticatedData4 : AuthenticatedData %% AuthenticatedData4 recursion level 1 with max 1 class AuthenticatedData4{ Version IsoNumber MAC IsoMax140Binary } AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType11 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). | AuthenticatedData4 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorReconciliationResponseV04 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationResponseV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationResponseV04Document implements IOuterDocument. Because AcceptorReconciliationResponseV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationResponseV04.
classDiagram class IOuterRecord AcceptorReconciliationResponseV04 --|> IOuterRecord : Implements AcceptorReconciliationResponseV04Document --|> IOuterDocument~AcceptorReconciliationResponseV04~ : Implements class IOuterDocument~AcceptorReconciliationResponseV04~ { AcceptorReconciliationResponseV04 Message }
Document wrapper for serialization
The only real purpose AcceptorReconciliationResponseV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.010.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationResponseV04.ToDocument() method. The returned AcceptorReconciliationResponseV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorReconciliationResponseV04Document *-- AcceptorReconciliationResponseV04 : 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.04">
<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="_lHle8WmAEeSxgrJ0GX4SQQ"
nextVersions="_8Wl3gY1MEeWXALXlV0Ei2w"
previousVersion="_1dGI8TJtEeOQDoPKFK41HQ"
name="AcceptorReconciliationResponseV04"
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="_lHmGAWmAEeSxgrJ0GX4SQQ"
type="purpose" />
<messageBuildingBlock
xmi:id="_lHmGA2mAEeSxgrJ0GX4SQQ"
nextVersions="_8Wl3hY1MEeWXALXlV0Ei2w"
previousVersion="_1dGI8zJtEeOQDoPKFK41HQ"
name="Header"
definition="Reconciliation response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
<messageBuildingBlock
xmi:id="_lHmGBWmAEeSxgrJ0GX4SQQ"
nextVersions="_8Wl3h41MEeWXALXlV0Ei2w"
previousVersion="_1dGI9TJtEeOQDoPKFK41HQ"
name="ReconciliationResponse"
definition="Information related to the reconciliation response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnRspn"
complexType="_BdxRYWmBEeSxgrJ0GX4SQQ" />
<messageBuildingBlock
xmi:id="_lHmGB2mAEeSxgrJ0GX4SQQ"
nextVersions="_8Wl3iY1MEeWXALXlV0Ei2w"
previousVersion="_1dGI9zJtEeOQDoPKFK41HQ"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_cg4dYWkIEeS7zPBpvm732w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="010"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.