Iso20022

AcceptorCurrencyConversionResponseV02

caaa.017.001.02

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
%% AcceptorCurrencyConversionResponseV02 recursion level 0 with max 0
AcceptorCurrencyConversionResponseV02 *-- "1..1" Header10 : Header
AcceptorCurrencyConversionResponseV02 *-- "1..1" AcceptorCurrencyConversionResponse2 : CurrencyConversionResponse
AcceptorCurrencyConversionResponseV02 *-- "1..1" ContentInformationType11 : 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
%% Header10 recursion level 0 with max 1
class Header10{
    MessageFunction MessageFunction4Code
    ProtocolVersion IsoMax6Text
    ExchangeIdentification IsoMax3NumericText
    CreationDateTime IsoISODateTime
}
Header10 *-- "1..1" GenericIdentification53 : InitiatingParty
Header10 *-- "0..1" GenericIdentification53 : RecipientParty
Header10 *-- "0..0" Traceability2 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
    Identification IsoMax35Text
    Type PartyType3Code
    Issuer PartyType4Code
    Country IsoMin2Max3AlphaText
    ShortName IsoMax35Text
}
%% Traceability2 recursion level 1 with max 1
class Traceability2{
    TraceDateTimeIn IsoISODateTime
    TraceDateTimeOut IsoISODateTime
}
Traceability2 *-- "1..1" GenericIdentification76 : RelayIdentification

Header10 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. GenericIdentification53 - Required 1..1
RecipientParty Unique identification of the partner that is the recipient of the message exchange. GenericIdentification53 - Optional 0..1
Traceability Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. Traceability2 - 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
%% AcceptorCurrencyConversionResponse2 recursion level 0 with max 1
AcceptorCurrencyConversionResponse2 *-- "1..1" CardPaymentEnvironment33 : Environment
AcceptorCurrencyConversionResponse2 *-- "1..1" CardPaymentTransaction38 : Transaction
AcceptorCurrencyConversionResponse2 *-- "1..1" CurrencyConversion3 : CurrencyConversion
%% CardPaymentEnvironment33 recursion level 1 with max 1
CardPaymentEnvironment33 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment33 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment33 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment33 *-- "0..1" PaymentCard10 : Card
CardPaymentEnvironment33 *-- "0..1" CardPaymentToken2 : PaymentToken
%% CardPaymentTransaction38 recursion level 1 with max 1
class CardPaymentTransaction38{
    SaleReferenceIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax140Text
}
CardPaymentTransaction38 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction38 *-- "1..1" CardPaymentTransactionDetails20 : TransactionDetails
%% CurrencyConversion3 recursion level 1 with max 1
class CurrencyConversion3{
    Result CurrencyConversionResponse1Code
    ResultReason IsoMax35Text
}
CurrencyConversion3 *-- "0..1" CurrencyConversion2 : Conversion

AcceptorCurrencyConversionResponse2 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment33 - Required 1..1
Transaction Currency conversion of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction38 - Required 1..1
CurrencyConversion Details of the currency conversion. CurrencyConversion3 - 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
%% ContentInformationType11 recursion level 0 with max 1
class ContentInformationType11{
    ContentType ContentType2Code
}
ContentInformationType11 *-- "0..0" AuthenticatedData4 : AuthenticatedData
%% AuthenticatedData4 recursion level 1 with max 1
class AuthenticatedData4{
    Version IsoNumber
    MAC IsoMax140Binary
}
AuthenticatedData4 *-- "1..0" IRecipient4Choice : Recipient
AuthenticatedData4 *-- "1..1" AlgorithmIdentification15 : MACAlgorithm
AuthenticatedData4 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent

ContentInformationType11 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). AuthenticatedData4 - Unknown 0..0

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    AcceptorCurrencyConversionResponseV02 --|> IOuterRecord : Implements
    AcceptorCurrencyConversionResponseV02Document --|> IOuterDocument~AcceptorCurrencyConversionResponseV02~ : Implements
    class IOuterDocument~AcceptorCurrencyConversionResponseV02~ {
        AcceptorCurrencyConversionResponseV02 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCurrencyConversionResponseV02Document *-- AcceptorCurrencyConversionResponseV02 : 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.02">
    <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="_FjgiMWpGEeSesPRRJV9fGQ"
  nextVersions="_b3EYUY0kEeWzoK7sd7oTyw"
  previousVersion="_TvqhkDV5EeOi1s4IQTEREA"
  name="AcceptorCurrencyConversionResponseV02"
  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.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="AccptrCcyConvsRspn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <doclet
    xmi:id="_FjgiM2pGEeSesPRRJV9fGQ"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_FjgiNWpGEeSesPRRJV9fGQ"
    nextVersions="_b3EYVY0kEeWzoK7sd7oTyw"
    previousVersion="_BpGIUDV6EeOi1s4IQTEREA"
    name="Header"
    definition="Currency conversion response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
  <messageBuildingBlock
    xmi:id="_FjgiN2pGEeSesPRRJV9fGQ"
    nextVersions="_b3EYV40kEeWzoK7sd7oTyw"
    previousVersion="_GZofIDV6EeOi1s4IQTEREA"
    name="CurrencyConversionResponse"
    definition="Information related to the outcome of the currency conversion."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CcyConvsRspn"
    complexType="_N12L0WpGEeSesPRRJV9fGQ" />
  <messageBuildingBlock
    xmi:id="_FjgiOWpGEeSesPRRJV9fGQ"
    nextVersions="_b3EYWY0kEeWzoK7sd7oTyw"
    previousVersion="_MehZwDV6EeOi1s4IQTEREA"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC (message authentication code)."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_cg4dYWkIEeS7zPBpvm732w" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="017"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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