Iso20022

AcceptorCurrencyConversionRequestV05

caaa.016.001.05

The AcceptorCurrencyConversionRequest message is sent by the card acceptor to the currency conversion service provider to request if the cardholder is able to pay in the currency of its card.

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
%% AcceptorCurrencyConversionRequestV05 recursion level 0 with max 0
AcceptorCurrencyConversionRequestV05 *-- "1..1" Header35 : Header
AcceptorCurrencyConversionRequestV05 *-- "1..1" AcceptorCurrencyConversionRequest5 : CurrencyConversionRequest
AcceptorCurrencyConversionRequestV05 *-- "0..1" ContentInformationType16 : SecurityTrailer

Now, we will zero-in one-by-one on each of these building blocks.

Header building block

Currency Conversion request 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

CurrencyConversionRequest building block

Information related to the currency conversion request. Information related to the currency conversion request. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorCurrencyConversionRequest5 recursion level 0 with max 1
AcceptorCurrencyConversionRequest5 *-- "1..1" CardPaymentEnvironment68 : Environment
AcceptorCurrencyConversionRequest5 *-- "1..1" CardPaymentTransaction85 : Transaction
%% CardPaymentEnvironment68 recursion level 1 with max 1
CardPaymentEnvironment68 *-- "0..1" Acquirer4 : Acquirer
CardPaymentEnvironment68 *-- "0..1" Organisation32 : Merchant
CardPaymentEnvironment68 *-- "0..1" PointOfInteraction8 : POI
CardPaymentEnvironment68 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : CustomerDevice
CardPaymentEnvironment68 *-- "0..1" CustomerDevice1 : Wallet
CardPaymentEnvironment68 *-- "0..1" CardPaymentToken4 : PaymentToken
CardPaymentEnvironment68 *-- "0..1" Cardholder13 : Cardholder
CardPaymentEnvironment68 *-- "0..1" ContentInformationType17 : ProtectedCardholderData
%% CardPaymentTransaction85 recursion level 1 with max 1
class CardPaymentTransaction85{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType5Code
    AdditionalService CardPaymentServiceType9Code
    ServiceAttribute CardPaymentServiceType3Code
    MerchantCategoryCode IsoMin3Max4Text
    SaleReferenceIdentification IsoMax35Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction85 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction85 *-- "0..1" CardPaymentTransaction86 : OriginalTransaction
CardPaymentTransaction85 *-- "1..1" CardPaymentTransactionDetails46 : TransactionDetails

AcceptorCurrencyConversionRequest5 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment68 - Required 1..1
Transaction Card payment transaction for which the currency conversion is requested. CardPaymentTransaction85 - 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
%% 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 AcceptorCurrencyConversionRequestV05 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionRequestV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionRequestV05Document implements IOuterDocument. Because AcceptorCurrencyConversionRequestV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionRequestV05.

classDiagram
    class IOuterRecord
    AcceptorCurrencyConversionRequestV05 --|> IOuterRecord : Implements
    AcceptorCurrencyConversionRequestV05Document --|> IOuterDocument~AcceptorCurrencyConversionRequestV05~ : Implements
    class IOuterDocument~AcceptorCurrencyConversionRequestV05~ {
        AcceptorCurrencyConversionRequestV05 Message
     }

Document wrapper for serialization

The only real purpose AcceptorCurrencyConversionRequestV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.016.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionRequestV05.ToDocument() method. The returned AcceptorCurrencyConversionRequestV05Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    AcceptorCurrencyConversionRequestV05Document *-- AcceptorCurrencyConversionRequestV05 : 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.016.001.05">
    <AccptrCcyConvsReq>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <CcyConvsReq>
            <!-- CurrencyConversionRequest inner content -->
        </CcyConvsReq>
        <SctyTrlr>
            <!-- SecurityTrailer inner content -->
        </SctyTrlr>
    </AccptrCcyConvsReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_GiBpQds5Eee9e6xduATmQg"
  nextVersions="_N0bCgdelEeiJyp_aycJaTw"
  previousVersion="_MIALIaqMEeanIZ10Ka8PnA"
  name="AcceptorCurrencyConversionRequestV05"
  definition="The AcceptorCurrencyConversionRequest message is sent by the card acceptor to the currency conversion service provider to request if the cardholder is able to pay in the currency of its card.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCcyConvsReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_GiBpQ9s5Eee9e6xduATmQg"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_GiBpRds5Eee9e6xduATmQg"
    nextVersions="_N0bChdelEeiJyp_aycJaTw"
    previousVersion="_MIALJaqMEeanIZ10Ka8PnA"
    name="Header"
    definition="Currency Conversion request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_igU6wdnGEeeN3v2fup_Shw" />
  <messageBuildingBlock
    xmi:id="_GiBpR9s5Eee9e6xduATmQg"
    nextVersions="_N0bCh9elEeiJyp_aycJaTw"
    previousVersion="_MIALJ6qMEeanIZ10Ka8PnA"
    name="CurrencyConversionRequest"
    definition="Information related to the currency conversion request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CcyConvsReq"
    complexType="_2IawAdtYEee9e6xduATmQg" />
  <messageBuildingBlock
    xmi:id="_GiBpSds5Eee9e6xduATmQg"
    nextVersions="_N0bCidelEeiJyp_aycJaTw"
    previousVersion="_MIALKaqMEeanIZ10Ka8PnA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="SctyTrlr"
    complexType="_Wb7MEds3Eee9e6xduATmQg" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="016"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.