caaa.009.001.05
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
%% AcceptorReconciliationRequestV05 recursion level 0 with max 0
AcceptorReconciliationRequestV05 *-- "1..1" Header30 : Header
AcceptorReconciliationRequestV05 *-- "1..1" AcceptorReconciliationRequest5 : ReconciliationRequest
AcceptorReconciliationRequestV05 *-- "0..1" ContentInformationType15 : 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
%% Header30 recursion level 0 with max 1
class Header30{
MessageFunction MessageFunction10Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header30 *-- "1..1" GenericIdentification53 : InitiatingParty
Header30 *-- "0..1" GenericIdentification94 : RecipientParty
Header30 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification
Header30 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction10Code - Required 1..1 |
| ProtocolVersion | Version of the acquirer protocol specifications. | IsoMax6Text - Required 1..1 |
| ExchangeIdentification | Unique identification of an exchange occurrence. | IsoNumber - 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. | GenericIdentification94 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability5 - Unknown 0..0 |
ReconciliationRequest building block
Information related to the reconciliation request. Reconciliation request from an acceptor. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorReconciliationRequest5 recursion level 0 with max 1
AcceptorReconciliationRequest5 *-- "1..1" CardPaymentEnvironment50 : Environment
AcceptorReconciliationRequest5 *-- "1..1" TransactionReconciliation4 : Transaction
%% CardPaymentEnvironment50 recursion level 1 with max 1
CardPaymentEnvironment50 *-- "1..1" Acquirer4 : Acquirer
CardPaymentEnvironment50 *-- "0..1" GenericIdentification53 : MerchantIdentification
CardPaymentEnvironment50 *-- "0..1" GenericIdentification53 : POIIdentification
CardPaymentEnvironment50 *-- "0..0" PointOfInteractionComponent6 : POIComponent
%% TransactionReconciliation4 recursion level 1 with max 1
class TransactionReconciliation4{
ClosePeriod IsoTrueFalseIndicator
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
TransactionReconciliation4 *-- "1..1" TransactionIdentifier1 : ReconciliationTransactionIdentification
TransactionReconciliation4 *-- "0..0" TransactionTotals7 : TransactionTotals
AcceptorReconciliationRequest5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment50 - Required 1..1 |
| Transaction | Reconciliation transaction between an acceptor an acquirer. | TransactionReconciliation4 - 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
%% ContentInformationType15 recursion level 0 with max 1
class ContentInformationType15{
ContentType ContentType2Code
}
ContentInformationType15 *-- "1..1" 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
ContentInformationType15 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 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorReconciliationRequestV05 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationRequestV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationRequestV05Document implements IOuterDocument. Because AcceptorReconciliationRequestV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationRequestV05.
classDiagram
class IOuterRecord
AcceptorReconciliationRequestV05 --|> IOuterRecord : Implements
AcceptorReconciliationRequestV05Document --|> IOuterDocument~AcceptorReconciliationRequestV05~ : Implements
class IOuterDocument~AcceptorReconciliationRequestV05~ {
AcceptorReconciliationRequestV05 Message
}
Document wrapper for serialization
The only real purpose AcceptorReconciliationRequestV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.009.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationRequestV05.ToDocument() method. The returned AcceptorReconciliationRequestV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorReconciliationRequestV05Document *-- AcceptorReconciliationRequestV05 : 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.05">
<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="_VsHKwY1MEeWXALXlV0Ei2w"
nextVersions="_BRNEYbClEeapjPTKZHuM2w"
previousVersion="_RuCs0Wl_EeSxgrJ0GX4SQQ"
name="AcceptorReconciliationRequestV05"
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">
<doclet
xmi:id="_VsHKw41MEeWXALXlV0Ei2w"
type="purpose" />
<messageBuildingBlock
xmi:id="_VsHKxY1MEeWXALXlV0Ei2w"
nextVersions="_BRNEZbClEeapjPTKZHuM2w"
previousVersion="_RuCs1Wl_EeSxgrJ0GX4SQQ"
name="Header"
definition="Reconciliation request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_IWFRgY0PEeWRYffwL7E13A" />
<messageBuildingBlock
xmi:id="_VsHKx41MEeWXALXlV0Ei2w"
nextVersions="_BRNEZ7ClEeapjPTKZHuM2w"
previousVersion="_RuCs12l_EeSxgrJ0GX4SQQ"
name="ReconciliationRequest"
definition="Information related to the reconciliation request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnReq"
complexType="_m9DuIY1MEeWXALXlV0Ei2w" />
<messageBuildingBlock
xmi:id="_VsHKyY1MEeWXALXlV0Ei2w"
nextVersions="_BRNEabClEeapjPTKZHuM2w"
previousVersion="_RuCs2Wl_EeSxgrJ0GX4SQQ"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_uSOuUCrHEeWRf8RNsvC5fQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="009"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.