Iso20022

AcceptorCurrencyConversionResponseV01

caaa.017.001.01

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
%% AcceptorCurrencyConversionResponseV01 recursion level 0 with max 0
AcceptorCurrencyConversionResponseV01 *-- "1..1" Header7 : Header
AcceptorCurrencyConversionResponseV01 *-- "1..1" AcceptorCurrencyConversionResponse1 : CurrencyConversionResponse
AcceptorCurrencyConversionResponseV01 *-- "1..1" ContentInformationType8 : 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
%% 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

CurrencyConversionResponse building block

Information related to the outcome of the currency conversion. Currencey conversion outcome from the service provider. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% AcceptorCurrencyConversionResponse1 recursion level 0 with max 1
class AcceptorCurrencyConversionResponse1{
    TransactionResponse Response1Code
}
AcceptorCurrencyConversionResponse1 *-- "1..1" CardPaymentEnvironment21 : Environment
AcceptorCurrencyConversionResponse1 *-- "1..1" CardPaymentTransaction23 : Transaction
AcceptorCurrencyConversionResponse1 *-- "1..1" CurrencyConversion1 : CurrencyConversion
%% CardPaymentEnvironment21 recursion level 1 with max 1
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : AcquirerIdentification
CardPaymentEnvironment21 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment21 *-- "1..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment21 *-- "0..1" ContentInformationType7 : ProtectedCardData
CardPaymentEnvironment21 *-- "0..1" PlainCardData5 : PlainCardData
%% CardPaymentTransaction23 recursion level 1 with max 1
class CardPaymentTransaction23{
    SaleReferenceIdentification IsoMax35Text
    RecipientTransactionIdentification IsoMax35Text
    ReconciliationIdentification IsoMax35Text
    InterchangeData IsoMax35Text
}
CardPaymentTransaction23 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction23 *-- "1..1" CardPaymentTransactionDetails13 : TransactionDetails
%% CurrencyConversion1 recursion level 1 with max 1
class CurrencyConversion1{
    CurrencyConversionIdentification IsoMax35Text
    Result CurrencyConversionResponse1Code
    ResponseReason IsoMax35Text
    TargetCurrency CurrencyCode
    TargetCurrencyNumeric IsoExact3NumericText
    TargetCurrencyDecimal IsoNumber
    TargetCurrencyName IsoMax35Text
    ResultingAmount IsoImpliedCurrencyAndAmount
    ExchangeRate IsoPercentageRate
    InvertedExchangeRate IsoPercentageRate
    QuotationDate IsoISODateTime
    ValidUntil IsoISODateTime
    SourceCurrency CurrencyCode
    SourceCurrencyNumeric CurrencyCode
    SourceCurrencyDecimal IsoNumber
    SourceCurrencyName IsoMax35Text
    OriginalAmount IsoImpliedCurrencyAndAmount
    DeclarationDetails IsoMax2048Text
}
CurrencyConversion1 *-- "0..0" Commission19 : CommissionDetails
CurrencyConversion1 *-- "0..0" Commission18 : MarkUpDetails

AcceptorCurrencyConversionResponse1 members

Member name Description Data Type / Multiplicity
Environment Environment of the transaction. CardPaymentEnvironment21 - Required 1..1
Transaction Currency conversion of a card payment transaction between an acceptor and an acquirer. CardPaymentTransaction23 - Required 1..1
TransactionResponse Result of the currency conversion. Response1Code - Required 1..1
CurrencyConversion Details of the currency conversion. CurrencyConversion1 - 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
%% 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 AcceptorCurrencyConversionResponseV01 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionResponseV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionResponseV01Document implements IOuterDocument. Because AcceptorCurrencyConversionResponseV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionResponseV01.

classDiagram
    class IOuterRecord
    AcceptorCurrencyConversionResponseV01 --|> IOuterRecord : Implements
    AcceptorCurrencyConversionResponseV01Document --|> IOuterDocument~AcceptorCurrencyConversionResponseV01~ : Implements
    class IOuterDocument~AcceptorCurrencyConversionResponseV01~ {
        AcceptorCurrencyConversionResponseV01 Message
     }

Document wrapper for serialization

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

classDiagram
    AcceptorCurrencyConversionResponseV01Document *-- AcceptorCurrencyConversionResponseV01 : 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.01">
    <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="_TvqhkDV5EeOi1s4IQTEREA"
  nextVersions="_FjgiMWpGEeSesPRRJV9fGQ"
  name="AcceptorCurrencyConversionResponseV01"
  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="_T4u-ADV5EeOi1s4IQTEREA"
    type="purpose" />
  <messageBuildingBlock
    xmi:id="_BpGIUDV6EeOi1s4IQTEREA"
    nextVersions="_FjgiNWpGEeSesPRRJV9fGQ"
    name="Header"
    definition="Currency conversion response message management information."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_UNSh8S9IEeOlZIh7PImd0A" />
  <messageBuildingBlock
    xmi:id="_GZofIDV6EeOi1s4IQTEREA"
    nextVersions="_FjgiN2pGEeSesPRRJV9fGQ"
    name="CurrencyConversionResponse"
    definition="Information related to the outcome of the currency conversion."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="CcyConvsRspn"
    complexType="_-NOcMDVqEeOT2JATPlD1fA" />
  <messageBuildingBlock
    xmi:id="_MehZwDV6EeOi1s4IQTEREA"
    nextVersions="_FjgiOWpGEeSesPRRJV9fGQ"
    name="SecurityTrailer"
    definition="Trailer of the message containing a MAC (message authentication code)."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SctyTrlr"
    complexType="_KpedcTF5EeO118ZQJgaQSQ" />
  <messageDefinitionIdentifier
    businessArea="caaa"
    messageFunctionality="017"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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