caaa.017.001.08
The AcceptorCurrencyConversionResponse message is sent by currency conversion service provider to the card acceptor to return the result of a potential currency conversion for the cardholder.
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 %% AcceptorCurrencyConversionResponseV08 recursion level 0 with max 0 AcceptorCurrencyConversionResponseV08 *-- "1..1" Header59 : Header AcceptorCurrencyConversionResponseV08 *-- "1..1" AcceptorCurrencyConversionResponse8 : CurrencyConversionResponse AcceptorCurrencyConversionResponseV08 *-- "0..1" ContentInformationType27 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Currency conversion response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Header59 recursion level 0 with max 1 class Header59{ MessageFunction MessageFunction42Code ProtocolVersion IsoMax6Text ExchangeIdentification IsoNumber ReTransmissionCounter IsoMax3NumericText CreationDateTime IsoISODateTime } Header59 *-- "1..1" GenericIdentification176 : InitiatingParty Header59 *-- "0..1" GenericIdentification177 : RecipientParty Header59 *-- "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
Header59 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageFunction | Identifies the type of process related to the message. | MessageFunction42Code - 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 |
CurrencyConversionResponse building block
Information related to the outcome of the currency conversion. Currency conversion outcome from the service provider. For comparison, see the ISO20022 official specification
classDiagram direction tb %% AcceptorCurrencyConversionResponse8 recursion level 0 with max 1 AcceptorCurrencyConversionResponse8 *-- "1..1" CardPaymentEnvironment77 : Environment AcceptorCurrencyConversionResponse8 *-- "1..1" CardPaymentTransaction111 : Transaction AcceptorCurrencyConversionResponse8 *-- "1..1" CurrencyConversion22 : CurrencyConversionResult %% CardPaymentEnvironment77 recursion level 1 with max 1 CardPaymentEnvironment77 *-- "0..1" Acquirer10 : Acquirer CardPaymentEnvironment77 *-- "0..1" Organisation41 : Merchant CardPaymentEnvironment77 *-- "0..1" PointOfInteraction11 : POI CardPaymentEnvironment77 *-- "0..1" PaymentCard31 : Card CardPaymentEnvironment77 *-- "0..1" Check1 : Check CardPaymentEnvironment77 *-- "0..0" StoredValueAccount2 : StoredValueAccount CardPaymentEnvironment77 *-- "0..0" LoyaltyAccount2 : LoyaltyAccount CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : CustomerDevice CardPaymentEnvironment77 *-- "0..1" CustomerDevice3 : Wallet CardPaymentEnvironment77 *-- "0..1" Token1 : PaymentToken CardPaymentEnvironment77 *-- "0..1" MerchantToken1 : MerchantToken CardPaymentEnvironment77 *-- "0..1" Cardholder17 : Cardholder CardPaymentEnvironment77 *-- "0..1" ContentInformationType28 : ProtectedCardholderData CardPaymentEnvironment77 *-- "0..1" RetailerSaleEnvironment2 : SaleEnvironment %% CardPaymentTransaction111 recursion level 1 with max 1 class CardPaymentTransaction111{ SaleReferenceIdentification IsoMax35Text InitiatorTransactionIdentification IsoMax35Text RecipientTransactionIdentification IsoMax140Text ReconciliationIdentification IsoMax35Text InterchangeData IsoMax140Text MerchantReferenceData IsoMax70Text } CardPaymentTransaction111 *-- "1..1" TransactionIdentifier1 : TransactionIdentification CardPaymentTransaction111 *-- "1..1" CardPaymentTransactionDetails49 : TransactionDetails %% CurrencyConversion22 recursion level 1 with max 1 class CurrencyConversion22{ Result CurrencyConversionResponse3Code ResultReason IsoMax35Text } CurrencyConversion22 *-- "0..0" CurrencyConversion20 : ConversionDetails
AcceptorCurrencyConversionResponse8 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
Environment | Environment of the transaction. | CardPaymentEnvironment77 - Required 1..1 |
Transaction | Currency conversion of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction111 - Required 1..1 |
CurrencyConversionResult | Details of the currency conversion. | CurrencyConversion22 - Required 1..1 |
SecurityTrailer building block
Trailer of the message containing a MAC (message authentication code). General cryptographic message syntax (CMS) containing authenticated data. For comparison, see the ISO20022 official specification
classDiagram direction tb %% ContentInformationType27 recursion level 0 with max 1 class ContentInformationType27{ ContentType ContentType2Code } ContentInformationType27 *-- "1..1" AuthenticatedData7 : AuthenticatedData %% AuthenticatedData7 recursion level 1 with max 1 class AuthenticatedData7{ Version IsoNumber MAC IsoMax140Binary } AuthenticatedData7 *-- "1..0" IRecipient10Choice : Recipient AuthenticatedData7 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm AuthenticatedData7 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType27 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). | AuthenticatedData7 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCurrencyConversionResponseV08 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionResponseV08 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionResponseV08Document implements IOuterDocument. Because AcceptorCurrencyConversionResponseV08 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionResponseV08.
classDiagram class IOuterRecord AcceptorCurrencyConversionResponseV08 --|> IOuterRecord : Implements AcceptorCurrencyConversionResponseV08Document --|> IOuterDocument~AcceptorCurrencyConversionResponseV08~ : Implements class IOuterDocument~AcceptorCurrencyConversionResponseV08~ { AcceptorCurrencyConversionResponseV08 Message }
Document wrapper for serialization
The only real purpose AcceptorCurrencyConversionResponseV08Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.017.001.08’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionResponseV08.ToDocument() method. The returned AcceptorCurrencyConversionResponseV08Document value will serialize correctly according to ISO 20022 standards.
classDiagram AcceptorCurrencyConversionResponseV08Document *-- AcceptorCurrencyConversionResponseV08 : 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.017.001.08">
<AccptrCcyConvsRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CcyConvsRspn>
<!-- CurrencyConversionResponse inner content -->
</CcyConvsRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCcyConvsRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_0RQ-oS5IEeunNvJlR_vCbg"
nextVersions="_b-b8QU4DEey_VecAUE-C9Q"
previousVersion="_Uv_E0QujEeqw5uEXxQ9H4g"
name="AcceptorCurrencyConversionResponseV08"
definition="The AcceptorCurrencyConversionResponse message is sent by currency conversion service provider to the card acceptor to return the result of a potential currency conversion for the cardholder.
"
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCcyConvsRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_0RQ-oy5IEeunNvJlR_vCbg"
type="purpose" />
<messageBuildingBlock
xmi:id="_0RQ-pS5IEeunNvJlR_vCbg"
nextVersions="_b-b8RU4DEey_VecAUE-C9Q"
previousVersion="_Uv_E1QujEeqw5uEXxQ9H4g"
name="Header"
definition="Currency conversion response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_Rz5m4S_aEeugIJ3Gvoevmg" />
<messageBuildingBlock
xmi:id="_0RQ-py5IEeunNvJlR_vCbg"
nextVersions="_b-b8R04DEey_VecAUE-C9Q"
previousVersion="_Uv_E1wujEeqw5uEXxQ9H4g"
name="CurrencyConversionResponse"
definition="Information related to the outcome of the currency conversion."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CcyConvsRspn"
complexType="_wNrNYS5IEeunNvJlR_vCbg" />
<messageBuildingBlock
xmi:id="_0RQ-qS5IEeunNvJlR_vCbg"
nextVersions="_b-b8SU4DEey_VecAUE-C9Q"
previousVersion="_Uv_E2QujEeqw5uEXxQ9H4g"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC (message authentication code)."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_2S4usS8lEeu125Ip9zFcsQ" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="017"
flavour="001"
version="08" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.