Iso20022

AcceptorCurrencyConversionRequestV10

caaa.016.001.10

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
%% AcceptorCurrencyConversionRequestV10 recursion level 0 with max 0
AcceptorCurrencyConversionRequestV10 *-- "1..1" Header70 : Header
AcceptorCurrencyConversionRequestV10 *-- "1..1" AcceptorCurrencyConversionRequest10 : CurrencyConversionRequest
AcceptorCurrencyConversionRequestV10 *-- "0..1" ContentInformationType36 : 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
%% 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

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
%% AcceptorCurrencyConversionRequest10 recursion level 0 with max 1
AcceptorCurrencyConversionRequest10 *-- "1..1" CardPaymentEnvironment79 : Environment
AcceptorCurrencyConversionRequest10 *-- "0..1" CardPaymentTransaction127 : Transaction
%% 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
%% CardPaymentTransaction127 recursion level 1 with max 1
class CardPaymentTransaction127{
    TransactionCapture IsoTrueFalseIndicator
    TransactionType CardPaymentServiceType5Code
    AdditionalService CardPaymentServiceType9Code
    ServiceAttribute CardPaymentServiceType14Code
    LastTransactionFlag IsoTrueFalseIndicator
    MerchantCategoryCode IsoMin3Max4Text
    SaleReferenceIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    IssuerReferenceData IsoMax140Text
    IssuerCITIdentification IsoMax140Text
    MerchantCITIdentification IsoMax140Text
    MerchantReferenceData IsoMax70Text
    CustomerConsent IsoTrueFalseIndicator
    CardProgrammeProposed IsoMax35Text
    CardProgrammeApplied IsoMax35Text
    SaleToPOIData IsoMax70Text
    SaleToAcquirerData IsoMax70Text
    SaleToIssuerData IsoMax70Text
    AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction127 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction127 *-- "0..1" CardPaymentTransaction126 : OriginalTransaction
CardPaymentTransaction127 *-- "1..1" CardPaymentTransactionDetails52 : TransactionDetails
CardPaymentTransaction127 *-- "0..1" AuthorisationResult18 : AuthorisationResult
CardPaymentTransaction127 *-- "0..1" CustomerOrder1 : CustomerOrder
CardPaymentTransaction127 *-- "0..1" CardPaymentToken5 : CustomerToken

AcceptorCurrencyConversionRequest10 members

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

classDiagram
    class IOuterRecord
    AcceptorCurrencyConversionRequestV10 --|> IOuterRecord : Implements
    AcceptorCurrencyConversionRequestV10Document --|> IOuterDocument~AcceptorCurrencyConversionRequestV10~ : Implements
    class IOuterDocument~AcceptorCurrencyConversionRequestV10~ {
        AcceptorCurrencyConversionRequestV10 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCurrencyConversionRequestV10Document *-- AcceptorCurrencyConversionRequestV10 : 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.10">
    <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="_WUjDIXMdEe2vXY6MoVq19w"
  previousVersion="_hBufsU3yEey_VecAUE-C9Q"
  name="AcceptorCurrencyConversionRequestV10"
  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="_uZD3QJVOEeO6Q83g-JIX_w"
  xmlTag="AccptrCcyConvsReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_WUjDI3MdEe2vXY6MoVq19w"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_WUjDJXMdEe2vXY6MoVq19w"
    previousVersion="_hBuftU3yEey_VecAUE-C9Q"
    name="Header"
    definition="Currency Conversion request message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_15eK4XJLEe299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_WUjDJ3MdEe2vXY6MoVq19w"
    previousVersion="_hBuft03yEey_VecAUE-C9Q"
    name="CurrencyConversionRequest"
    definition="Information related to the currency conversion request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CcyConvsReq"
    complexType="_FZkiQXJ5Ee299ZbWCkdR_w" />
  <messageBuildingBlock
    xmi:id="_WUjDKXMdEe2vXY6MoVq19w"
    previousVersion="_hBufuU3yEey_VecAUE-C9Q"
    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="016"
    flavour="001"
    version="10" />
</messageDefinition>

ISO Building Blocks

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