caaa.017.001.06
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
%% AcceptorCurrencyConversionResponseV06 recursion level 0 with max 0
AcceptorCurrencyConversionResponseV06 *-- "1..1" Header35 : Header
AcceptorCurrencyConversionResponseV06 *-- "1..1" AcceptorCurrencyConversionResponse6 : CurrencyConversionResponse
AcceptorCurrencyConversionResponseV06 *-- "0..1" ContentInformationType16 : 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
%% Header35 recursion level 0 with max 1
class Header35{
MessageFunction MessageFunction14Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
CreationDateTime IsoISODateTime
}
Header35 *-- "1..1" GenericIdentification53 : InitiatingParty
Header35 *-- "0..1" GenericIdentification94 : RecipientParty
Header35 *-- "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
Header35 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction14Code - 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 |
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
%% AcceptorCurrencyConversionResponse6 recursion level 0 with max 1
AcceptorCurrencyConversionResponse6 *-- "1..1" CardPaymentEnvironment69 : Environment
AcceptorCurrencyConversionResponse6 *-- "1..1" CardPaymentTransaction88 : Transaction
AcceptorCurrencyConversionResponse6 *-- "1..1" CurrencyConversion16 : CurrencyConversionResult
%% CardPaymentEnvironment69 recursion level 1 with max 1
CardPaymentEnvironment69 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment69 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment69 *-- "0..1" CardPaymentToken4 : PaymentToken
%% CardPaymentTransaction88 recursion level 1 with max 1
class CardPaymentTransaction88{
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
InterchangeData IsoMax140Text
MerchantReferenceData IsoMax70Text
}
CardPaymentTransaction88 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction88 *-- "1..1" CardPaymentTransactionDetails47 : TransactionDetails
%% CurrencyConversion16 recursion level 1 with max 1
class CurrencyConversion16{
Result CurrencyConversionResponse3Code
ResultReason IsoMax35Text
}
CurrencyConversion16 *-- "0..0" CurrencyConversion14 : ConversionDetails
AcceptorCurrencyConversionResponse6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment69 - Required 1..1 |
| Transaction | Currency conversion of a card payment transaction between an acceptor and an acquirer. | CardPaymentTransaction88 - Required 1..1 |
| CurrencyConversionResult | Details of the currency conversion. | CurrencyConversion16 - 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
%% ContentInformationType16 recursion level 0 with max 1
class ContentInformationType16{
ContentType ContentType2Code
}
ContentInformationType16 *-- "1..1" AuthenticatedData5 : AuthenticatedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType16 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). | AuthenticatedData5 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCurrencyConversionResponseV06 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionResponseV06 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionResponseV06Document implements IOuterDocument. Because AcceptorCurrencyConversionResponseV06 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionResponseV06.
classDiagram
class IOuterRecord
AcceptorCurrencyConversionResponseV06 --|> IOuterRecord : Implements
AcceptorCurrencyConversionResponseV06Document --|> IOuterDocument~AcceptorCurrencyConversionResponseV06~ : Implements
class IOuterDocument~AcceptorCurrencyConversionResponseV06~ {
AcceptorCurrencyConversionResponseV06 Message
}
Document wrapper for serialization
The only real purpose AcceptorCurrencyConversionResponseV06Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.017.001.06’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionResponseV06.ToDocument() method. The returned AcceptorCurrencyConversionResponseV06Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCurrencyConversionResponseV06Document *-- AcceptorCurrencyConversionResponseV06 : 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.06">
<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="_apDLkdelEeiJyp_aycJaTw"
nextVersions="_Uv_E0QujEeqw5uEXxQ9H4g"
previousVersion="_LmgPwds5Eee9e6xduATmQg"
name="AcceptorCurrencyConversionResponseV06"
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="_apDLk9elEeiJyp_aycJaTw"
type="purpose" />
<messageBuildingBlock
xmi:id="_apDLldelEeiJyp_aycJaTw"
nextVersions="_Uv_E1QujEeqw5uEXxQ9H4g"
previousVersion="_LmgPxds5Eee9e6xduATmQg"
name="Header"
definition="Currency conversion response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_igU6wdnGEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_apDLl9elEeiJyp_aycJaTw"
nextVersions="_Uv_E1wujEeqw5uEXxQ9H4g"
previousVersion="_Lmg20ds5Eee9e6xduATmQg"
name="CurrencyConversionResponse"
definition="Information related to the outcome of the currency conversion."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CcyConvsRspn"
complexType="_fhlAwdelEeiJyp_aycJaTw" />
<messageBuildingBlock
xmi:id="_apDLmdelEeiJyp_aycJaTw"
nextVersions="_Uv_E2QujEeqw5uEXxQ9H4g"
previousVersion="_Lmg209s5Eee9e6xduATmQg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC (message authentication code)."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_Wb7MEds3Eee9e6xduATmQg" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="017"
flavour="001"
version="06" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.