Iso20022

AcceptorCurrencyConversionRequestV01

caaa.016.001.01

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
%% AcceptorCurrencyConversionRequestV01 recursion level 0 with max 0
AcceptorCurrencyConversionRequestV01 *-- "1..1" Header7 : Header
AcceptorCurrencyConversionRequestV01 *-- "1..1" AcceptorCurrencyConversionRequest1 : CurrencyConversionRequest
AcceptorCurrencyConversionRequestV01 *-- "1..1" ContentInformationType8 : 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
%% Header7 recursion level 0 with max 1
class Header7{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header7 *-- "1..1" GenericIdentification32 : InitiatingParty
Header7 *-- "0..1" GenericIdentification32 : RecipientParty
Header7 *-- "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

Header7 members

Member name Description Data Type / Multiplicity
MessageFunction Identifies the type of process related to the message. MessageFunction4Code - 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

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
%% AcceptorCurrencyConversionRequest1 recursion level 0 with max 1
AcceptorCurrencyConversionRequest1 *-- "1..1" CardPaymentEnvironment30 : Environment
AcceptorCurrencyConversionRequest1 *-- "1..1" CardPaymentTransaction34 : Transaction
%% CardPaymentEnvironment30 recursion level 1 with max 1
class CardPaymentEnvironment30{
    CardholderLanguage ISO2ALanguageCode
}
CardPaymentEnvironment30 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment30 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment30 *-- "1..1" PointOfInteraction3 : POI
CardPaymentEnvironment30 *-- "1..1" PaymentCard7 : Card
%% CardPaymentTransaction34 recursion level 1 with max 1
class CardPaymentTransaction34{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType5Code
    AdditionalService CardPaymentServiceType6Code
    ServiceAttribute CardPaymentServiceType3Code
    MerchantCategoryCode IsoMin3Max4Text
    SaleReferenceIdentification IsoMax35Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction34 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction34 *-- "0..1" CardPaymentTransaction33 : OriginalTransaction
CardPaymentTransaction34 *-- "1..1" CardPaymentTransactionDetails18 : TransactionDetails

AcceptorCurrencyConversionRequest1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment30 - Required 1..1
Transaction Card payment transaction for which the currency conversion is requested. CardPaymentTransaction34 - 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
%% ContentInformationType8 recursion level 0 with max 1
class ContentInformationType8{
    ContentType ContentType1Code
}
ContentInformationType8 *-- "0..0" AuthenticatedData3 : AuthenticatedData
%% AuthenticatedData3 recursion level 1 with max 1
class AuthenticatedData3{
    Version IsoNumber
    MAC IsoMax35Binary
}
AuthenticatedData3 *-- "1..0" IRecipient3Choice : Recipient
AuthenticatedData3 *-- "1..1" AlgorithmIdentification10 : MACAlgorithm
AuthenticatedData3 *-- "1..1" EncapsulatedContent2 : EncapsulatedContent

ContentInformationType8 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). AuthenticatedData3 - Unknown 0..0

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the AcceptorCurrencyConversionRequestV01 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionRequestV01Document implements IOuterDocument. Because AcceptorCurrencyConversionRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionRequestV01.

classDiagram
    class IOuterRecord
    AcceptorCurrencyConversionRequestV01 --|> IOuterRecord : Implements
    AcceptorCurrencyConversionRequestV01Document --|> IOuterDocument~AcceptorCurrencyConversionRequestV01~ : Implements
    class IOuterDocument~AcceptorCurrencyConversionRequestV01~ {
        AcceptorCurrencyConversionRequestV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCurrencyConversionRequestV01Document *-- AcceptorCurrencyConversionRequestV01 : 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.01">
    <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="_3cWp8DTpEeOLr8wG_Q16kw"
  nextVersions="_nFPwUWpCEeS4VPLpYyQgxQ"
  name="AcceptorCurrencyConversionRequestV01"
  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="_3gXnQDTpEeOLr8wG_Q16kw"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_9uHRADTrEeOLr8wG_Q16kw"
    nextVersions="_nFPwVWpCEeS4VPLpYyQgxQ"
    name="Header"
    definition="Currency Conversion request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_UNSh8S9IEeOlZIh7PImd0A" />
  <messageBuildingBlock
    xmi:id="_L1ZUwDTsEeOLr8wG_Q16kw"
    nextVersions="_nFPwV2pCEeS4VPLpYyQgxQ"
    name="CurrencyConversionRequest"
    definition="Information related to the currency conversion request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CcyConvsReq"
    complexType="_GtcD0DTpEeOLr8wG_Q16kw" />
  <messageBuildingBlock
    xmi:id="_VcubYDTsEeOLr8wG_Q16kw"
    nextVersions="_nFPwWWpCEeS4VPLpYyQgxQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_KpedcTF5EeO118ZQJgaQSQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="016"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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