caaa.019.001.06
The AcceptorCurrencyConversionAdviceResponse message is sent by the service provider to acknowledge the acceptor about the notification of the reception of the currency conversion advice.
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 %% AcceptorCurrencyConversionAdviceResponseV06 recursion level 0 with max 0 AcceptorCurrencyConversionAdviceResponseV06 *-- "1..1" Header70 : Header AcceptorCurrencyConversionAdviceResponseV06 *-- "1..1" AcceptorCancellationAdviceResponse11 : CurrencyConversionAdviceResponse AcceptorCurrencyConversionAdviceResponseV06 *-- "0..1" ContentInformationType36 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation advice response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Header70 recursion level 0 with max 1 class Header70{ MessageFunction MessageFunction46Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoNumber ReTransmissionCounter IsoMax3NumericText CreationDateTime IsoISODateTime } Header70 *-- "1..1" GenericIdentification176 : InitiatingParty Header70 *-- "0..1" GenericIdentification177 : RecipientParty Header70 *-- "0..0" Traceability8 : Traceability %% GenericIdentification176 recursion level 1 with max 1 class GenericIdentification176{ Identification IsoMax35Text Type PartyType33Code Issuer PartyType33Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } %% GenericIdentification177 recursion level 1 with max 1 class GenericIdentification177{ Identification IsoMax35Text Type PartyType33Code Issuer PartyType33Code Country IsoMin2Max3AlphaText ShortName IsoMax35Text } GenericIdentification177 *-- "0..1" NetworkParameters7 : RemoteAccess GenericIdentification177 *-- "0..1" Geolocation1 : Geolocation %% Traceability8 recursion level 1 with max 1 class Traceability8{ ProtocolName IsoMax35Text ProtocolVersion IsoMax6Text TraceDateTimeIn IsoISODateTime TraceDateTimeOut IsoISODateTime } Traceability8 *-- "1..1" GenericIdentification177 : RelayIdentification
Header70 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | MessageFunction46Code - 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 |
ReTransmissionCounter | Number of retransmissions of the message. | IsoMax3NumericText - Optional 0..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. | GenericIdentification176 - Required 1..1 |
RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification177 - Optional 0..1 |
Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability8 - Unknown 0..0 |
CurrencyConversionAdviceResponse building block
Information related to the currency conversion advice response. Cancellation advice response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorCancellationAdviceResponse11 recursion level 0 with max 1 AcceptorCancellationAdviceResponse11 *-- "1..1" CardPaymentEnvironment79 : Environment AcceptorCancellationAdviceResponse11 *-- "1..1" CardPaymentTransactionAdviceResponse8 : Transaction AcceptorCancellationAdviceResponse11 *-- "0..1" TMSTrigger1 : TMSTrigger %% CardPaymentEnvironment79 recursion level 1 with max 1 CardPaymentEnvironment79 *-- "0..1" Acquirer10 : Acquirer CardPaymentEnvironment79 *-- "0..1" Acquirer10 : ServiceProvider CardPaymentEnvironment79 *-- "0..1" Organisation41 : Merchant CardPaymentEnvironment79 *-- "0..1" PointOfInteraction13 : POI CardPaymentEnvironment79 *-- "0..1" PaymentCard33 : Card CardPaymentEnvironment79 *-- "0..1" Check1 : Check CardPaymentEnvironment79 *-- "0..0" StoredValueAccount2 : StoredValueAccount CardPaymentEnvironment79 *-- "0..0" LoyaltyAccount3 : LoyaltyAccount CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : CustomerDevice CardPaymentEnvironment79 *-- "0..1" CustomerDevice3 : Wallet CardPaymentEnvironment79 *-- "0..1" Token1 : PaymentToken CardPaymentEnvironment79 *-- "0..1" MerchantToken2 : MerchantToken CardPaymentEnvironment79 *-- "0..1" Cardholder20 : Cardholder CardPaymentEnvironment79 *-- "0..1" ContentInformationType35 : ProtectedCardholderData CardPaymentEnvironment79 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment %% CardPaymentTransactionAdviceResponse8 recursion level 1 with max 1 class CardPaymentTransactionAdviceResponse8{ SaleReferenceIdentification IsoMax35Text InitiatorTransactionIdentification IsoMax35Text RecipientTransactionIdentification IsoMax140Text ReconciliationIdentification IsoMax35Text Response Response9Code } CardPaymentTransactionAdviceResponse8 *-- "1..1" TransactionIdentifier1 : TransactionIdentification %% TMSTrigger1 recursion level 1 with max 1 class TMSTrigger1{ TMSContactLevel TMSContactLevel1Code TMSIdentification IsoMax35Text TMSContactDateTime IsoISODateTime }
AcceptorCancellationAdviceResponse11 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Environment | Environment of the transaction. | CardPaymentEnvironment79 - Required 1..1 |
Transaction | Cancellation transaction from an acceptor to the acquirer. | CardPaymentTransactionAdviceResponse8 - Required 1..1 |
TMSTrigger | Instructions for contacting the terminal management host. | TMSTrigger1 - Optional 0..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 %% ContentInformationType36 recursion level 0 with max 1 class ContentInformationType36{ ContentType ContentType2Code } ContentInformationType36 *-- "1..1" AuthenticatedData9 : AuthenticatedData %% AuthenticatedData9 recursion level 1 with max 1 class AuthenticatedData9{ Version IsoNumber MAC IsoMax140Binary } AuthenticatedData9 *-- "1..0" IRecipient14Choice : Recipient AuthenticatedData9 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm AuthenticatedData9 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType36 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). | AuthenticatedData9 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCurrencyConversionAdviceResponseV06 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionAdviceResponseV06 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionAdviceResponseV06Document implements IOuterDocument. Because AcceptorCurrencyConversionAdviceResponseV06 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionAdviceResponseV06.
classDiagram class IOuterRecord AcceptorCurrencyConversionAdviceResponseV06 --|> IOuterRecord : Implements AcceptorCurrencyConversionAdviceResponseV06Document --|> IOuterDocument~AcceptorCurrencyConversionAdviceResponseV06~ : Implements class IOuterDocument~AcceptorCurrencyConversionAdviceResponseV06~ { AcceptorCurrencyConversionAdviceResponseV06 Message }
Document wrapper for serialization
The only real purpose AcceptorCurrencyConversionAdviceResponseV06Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.019.001.06’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionAdviceResponseV06.ToDocument() method. The returned AcceptorCurrencyConversionAdviceResponseV06Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorCurrencyConversionAdviceResponseV06Document *-- AcceptorCurrencyConversionAdviceResponseV06 : 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.019.001.06">
<AccptrCcyConvsAdvcRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CcyConvsAdvcRspn>
<!-- CurrencyConversionAdviceResponse inner content -->
</CcyConvsAdvcRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCcyConvsAdvcRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_h7qd8XMiEe2vXY6MoVq19w"
previousVersion="_MrhnQU7REeyGi9JAv6wq7Q"
name="AcceptorCurrencyConversionAdviceResponseV06"
definition="The AcceptorCurrencyConversionAdviceResponse message is sent by the service provider to acknowledge the acceptor about the notification of the reception of the currency conversion advice."
registrationStatus="Registered"
messageSet="_uZD3QJVOEeO6Q83g-JIX_w"
xmlTag="AccptrCcyConvsAdvcRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_h7qd83MiEe2vXY6MoVq19w"
type="purpose" />
<messageBuildingBlock
xmi:id="_h7qd9XMiEe2vXY6MoVq19w"
previousVersion="_MrhnRU7REeyGi9JAv6wq7Q"
name="Header"
definition="Cancellation advice response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_15eK4XJLEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_h7qd93MiEe2vXY6MoVq19w"
previousVersion="_MrhnR07REeyGi9JAv6wq7Q"
name="CurrencyConversionAdviceResponse"
definition="Information related to the currency conversion advice response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CcyConvsAdvcRspn"
complexType="_hWpnQXJwEe299ZbWCkdR_w" />
<messageBuildingBlock
xmi:id="_h7qd-XMiEe2vXY6MoVq19w"
previousVersion="_MrhnSU7REeyGi9JAv6wq7Q"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_WAiXsXJ9Ee299ZbWCkdR_w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="019"
flavour="001"
version="06" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.