caaa.016.001.02
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
%% AcceptorCurrencyConversionRequestV02 recursion level 0 with max 0
AcceptorCurrencyConversionRequestV02 *-- "1..1" Header10 : Header
AcceptorCurrencyConversionRequestV02 *-- "1..1" AcceptorCurrencyConversionRequest2 : CurrencyConversionRequest
AcceptorCurrencyConversionRequestV02 *-- "1..1" ContentInformationType11 : 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
%% 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 |
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
%% AcceptorCurrencyConversionRequest2 recursion level 0 with max 1
AcceptorCurrencyConversionRequest2 *-- "1..1" CardPaymentEnvironment44 : Environment
AcceptorCurrencyConversionRequest2 *-- "1..1" CardPaymentTransaction49 : Transaction
%% CardPaymentEnvironment44 recursion level 1 with max 1
class CardPaymentEnvironment44{
CardholderLanguage LanguageCode
}
CardPaymentEnvironment44 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment44 *-- "0..1" GenericIdentification53 : MerchantIdentification
CardPaymentEnvironment44 *-- "1..1" PointOfInteraction4 : POI
CardPaymentEnvironment44 *-- "1..1" PaymentCard9 : Card
%% CardPaymentTransaction49 recursion level 1 with max 1
class CardPaymentTransaction49{
TransactionCapture IsoTrueFalseIndicator
TransactionType CardPaymentServiceType5Code
AdditionalService CardPaymentServiceType6Code
ServiceAttribute CardPaymentServiceType3Code
MerchantCategoryCode IsoMin3Max4Text
SaleReferenceIdentification IsoMax35Text
AdditionalTransactionData IsoMax70Text
}
CardPaymentTransaction49 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
CardPaymentTransaction49 *-- "0..1" CardPaymentTransaction50 : OriginalTransaction
CardPaymentTransaction49 *-- "1..1" CardPaymentTransactionDetails26 : TransactionDetails
AcceptorCurrencyConversionRequest2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment44 - Required 1..1 |
| Transaction | Card payment transaction for which the currency conversion is requested. | CardPaymentTransaction49 - 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
%% 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 AcceptorCurrencyConversionRequestV02 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionRequestV02Document implements IOuterDocument. Because AcceptorCurrencyConversionRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionRequestV02.
classDiagram
class IOuterRecord
AcceptorCurrencyConversionRequestV02 --|> IOuterRecord : Implements
AcceptorCurrencyConversionRequestV02Document --|> IOuterDocument~AcceptorCurrencyConversionRequestV02~ : Implements
class IOuterDocument~AcceptorCurrencyConversionRequestV02~ {
AcceptorCurrencyConversionRequestV02 Message
}
Document wrapper for serialization
The only real purpose AcceptorCurrencyConversionRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.016.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionRequestV02.ToDocument() method. The returned AcceptorCurrencyConversionRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCurrencyConversionRequestV02Document *-- AcceptorCurrencyConversionRequestV02 : 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.02">
<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="_nFPwUWpCEeS4VPLpYyQgxQ"
nextVersions="_Lx3NEY3ZEeW56qaqQ8B0kQ"
previousVersion="_3cWp8DTpEeOLr8wG_Q16kw"
name="AcceptorCurrencyConversionRequestV02"
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.
"
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCcyConvsReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_nFPwU2pCEeS4VPLpYyQgxQ"
type="purpose" />
<messageBuildingBlock
xmi:id="_nFPwVWpCEeS4VPLpYyQgxQ"
nextVersions="_Lx3NFY3ZEeW56qaqQ8B0kQ"
previousVersion="_9uHRADTrEeOLr8wG_Q16kw"
name="Header"
definition="Currency Conversion request message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_EXmNsWeeEeSh-d9-KfCEyA" />
<messageBuildingBlock
xmi:id="_nFPwV2pCEeS4VPLpYyQgxQ"
nextVersions="_Lx3NF43ZEeW56qaqQ8B0kQ"
previousVersion="_L1ZUwDTsEeOLr8wG_Q16kw"
name="CurrencyConversionRequest"
definition="Information related to the currency conversion request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CcyConvsReq"
complexType="_uopQUWpCEeS4VPLpYyQgxQ" />
<messageBuildingBlock
xmi:id="_nFPwWWpCEeS4VPLpYyQgxQ"
nextVersions="_Lx3NGY3ZEeW56qaqQ8B0kQ"
previousVersion="_VcubYDTsEeOLr8wG_Q16kw"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SctyTrlr"
complexType="_cg4dYWkIEeS7zPBpvm732w" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="016"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.