caaa.010.001.01
Scope The AcceptorReconciliationResponse message is sent by the acquirer to communicate to the card acceptor the totals of the card payment transaction performed for the reconciliation period. An agent never forwards the message. Usage The AcceptorReconciliationResponse message is used to compare the totals between a card acceptor and an acquirer for the reconciliation period.
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
%% AcceptorReconciliationResponseV01 recursion level 0 with max 0
AcceptorReconciliationResponseV01 *-- "1..1" Header1 : Header
AcceptorReconciliationResponseV01 *-- "1..1" AcceptorReconciliationResponse1 : ReconciliationResponse
AcceptorReconciliationResponseV01 *-- "1..1" ContentInformationType3 : 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
%% AcceptorReconciliationResponse1 recursion level 0 with max 1
AcceptorReconciliationResponse1 *-- "1..1" CardPaymentEnvironment7 : Environment
AcceptorReconciliationResponse1 *-- "1..1" ResponseType1 : TransactionResponse
AcceptorReconciliationResponse1 *-- "1..1" TransactionReconciliation1 : Transaction
%% CardPaymentEnvironment7 recursion level 1 with max 1
CardPaymentEnvironment7 *-- "1..1" Acquirer1 : Acquirer
CardPaymentEnvironment7 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment7 *-- "0..1" GenericIdentification32 : POIIdentification
%% ResponseType1 recursion level 1 with max 1
class ResponseType1{
Response Response1Code
ResponseReason IsoMax35Text
}
%% TransactionReconciliation1 recursion level 1 with max 1
class TransactionReconciliation1{
ClosePeriod IsoTrueFalseIndicator
ReconciliationIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
TransactionReconciliation1 *-- "1..1" TransactionIdentifier1 : ReconciliationTransactionIdentification
TransactionReconciliation1 *-- "1..0" TransactionTotals1 : TransactionTotals
AcceptorReconciliationResponse1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment7 - Required 1..1 |
| TransactionResponse | Response from the acquirer to the reconciliation transaction. | ResponseType1 - Required 1..1 |
| Transaction | Reconciliation transaction between an acceptor an acquirer. | TransactionReconciliation1 - 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
%% ContentInformationType3 recursion level 0 with max 1
class ContentInformationType3{
ContentType ContentType1Code
}
ContentInformationType3 *-- "0..0" AuthenticatedData1 : AuthenticatedData
%% AuthenticatedData1 recursion level 1 with max 1
class AuthenticatedData1{
Version IsoNumber
MAC IsoMax35Binary
}
AuthenticatedData1 *-- "1..0" IRecipient1Choice : Recipient
AuthenticatedData1 *-- "1..1" AlgorithmIdentification1 : MACAlgorithm
AuthenticatedData1 *-- "1..1" EncapsulatedContent1 : EncapsulatedContent
ContentInformationType3 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). | AuthenticatedData1 - Unknown 0..0 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorReconciliationResponseV01 implementation follows a specific implementaiton pattern. First of all, AcceptorReconciliationResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorReconciliationResponseV01Document implements IOuterDocument. Because AcceptorReconciliationResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorReconciliationResponseV01.
classDiagram
class IOuterRecord
AcceptorReconciliationResponseV01 --|> IOuterRecord : Implements
AcceptorReconciliationResponseV01Document --|> IOuterDocument~AcceptorReconciliationResponseV01~ : Implements
class IOuterDocument~AcceptorReconciliationResponseV01~ {
AcceptorReconciliationResponseV01 Message
}
Document wrapper for serialization
The only real purpose AcceptorReconciliationResponseV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.010.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorReconciliationResponseV01.ToDocument() method. The returned AcceptorReconciliationResponseV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorReconciliationResponseV01Document *-- AcceptorReconciliationResponseV01 : 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.01">
<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="_OV5_1aMVEeCJ6YNENx4h-w_2086001955"
nextVersions="_3gM8MQvgEeK9Xewg3qiFQA"
name="AcceptorReconciliationResponseV01"
definition="Scope
The AcceptorReconciliationResponse message is sent by the acquirer to communicate to the card acceptor the totals of the card payment transaction performed for the reconciliation period. An agent never forwards the message.
Usage
The AcceptorReconciliationResponse message is used to compare the totals between a card acceptor and an acquirer for the reconciliation period."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrRcncltnRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_OV5_1qMVEeCJ6YNENx4h-w_1779414946"
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="_OV5_16MVEeCJ6YNENx4h-w_2117740989"
name="ReconciliationResponse"
definition="Information related to thereconciliation response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RcncltnRspn"
complexType="_Svfw-wEcEeCQm6a_G2yO_w_828551474" />
<messageBuildingBlock
xmi:id="_OV5_2KMVEeCJ6YNENx4h-w_-1540723473"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_SvV__AEcEeCQm6a_G2yO_w_153583816" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="010"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.