caaa.019.001.02
The AcceptorCurrencyConversionAdviceResponse message is sent by the service provider to acknowledge the acceptor about the notification of the reception of the currency conversion advice.
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
%% AcceptorCurrencyConversionAdviceResponseV02 recursion level 0 with max 0
AcceptorCurrencyConversionAdviceResponseV02 *-- "1..1" Header36 : Header
AcceptorCurrencyConversionAdviceResponseV02 *-- "1..1" AcceptorCancellationAdviceResponse7 : CurrencyConversionAdviceResponse
AcceptorCurrencyConversionAdviceResponseV02 *-- "0..1" ContentInformationType16 : SecurityTrailer
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Cancellation advice response message management information. Set of characteristics related to the protocol. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% Header36 recursion level 0 with max 1
class Header36{
MessageFunction MessageFunction14Code
ProtocolVersion IsoMax6Text
ExchangeIdentification IsoNumber
ReTransmissionCounter IsoMax3NumericText
CreationDateTime IsoISODateTime
}
Header36 *-- "1..1" GenericIdentification53 : InitiatingParty
Header36 *-- "0..1" GenericIdentification94 : RecipientParty
Header36 *-- "0..0" Traceability5 : Traceability
%% GenericIdentification53 recursion level 1 with max 1
class GenericIdentification53{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
%% GenericIdentification94 recursion level 1 with max 1
class GenericIdentification94{
Identification IsoMax35Text
Type PartyType3Code
Issuer PartyType4Code
Country IsoMin2Max3AlphaText
ShortName IsoMax35Text
}
GenericIdentification94 *-- "0..1" NetworkParameters5 : RemoteAccess
%% Traceability5 recursion level 1 with max 1
class Traceability5{
ProtocolName IsoMax35Text
ProtocolVersion IsoMax6Text
TraceDateTimeIn IsoISODateTime
TraceDateTimeOut IsoISODateTime
}
Traceability5 *-- "1..1" GenericIdentification76 : RelayIdentification
Header36 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageFunction | Identifies the type of process related to the message. | MessageFunction14Code - 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. | GenericIdentification53 - Required 1..1 |
| RecipientParty | Unique identification of the partner that is the recipient of the message exchange. | GenericIdentification94 - Optional 0..1 |
| Traceability | Identification of partners involved in exchange from the merchant to the issuer, with the relative timestamp of their exchanges. | Traceability5 - Unknown 0..0 |
CurrencyConversionAdviceResponse building block
Information related to the currency conversion advice response. Cancellation advice response from the acquirer. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% AcceptorCancellationAdviceResponse7 recursion level 0 with max 1
AcceptorCancellationAdviceResponse7 *-- "1..1" CardPaymentEnvironment69 : Environment
AcceptorCancellationAdviceResponse7 *-- "1..1" CardPaymentTransactionAdviceResponse6 : Transaction
AcceptorCancellationAdviceResponse7 *-- "0..1" TMSTrigger1 : TMSTrigger
%% CardPaymentEnvironment69 recursion level 1 with max 1
CardPaymentEnvironment69 *-- "0..1" GenericIdentification53 : AcquirerIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : MerchantIdentification
CardPaymentEnvironment69 *-- "0..1" GenericIdentification32 : POIIdentification
CardPaymentEnvironment69 *-- "0..1" PaymentCard28 : Card
CardPaymentEnvironment69 *-- "0..1" CardPaymentToken4 : PaymentToken
%% CardPaymentTransactionAdviceResponse6 recursion level 1 with max 1
class CardPaymentTransactionAdviceResponse6{
SaleReferenceIdentification IsoMax35Text
InitiatorTransactionIdentification IsoMax35Text
RecipientTransactionIdentification IsoMax35Text
ReconciliationIdentification IsoMax35Text
Response Response4Code
}
CardPaymentTransactionAdviceResponse6 *-- "1..1" TransactionIdentifier1 : TransactionIdentification
%% TMSTrigger1 recursion level 1 with max 1
class TMSTrigger1{
TMSContactLevel TMSContactLevel1Code
TMSIdentification IsoMax35Text
TMSContactDateTime IsoISODateTime
}
AcceptorCancellationAdviceResponse7 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Environment | Environment of the transaction. | CardPaymentEnvironment69 - Required 1..1 |
| Transaction | Cancellation transaction from an acceptor to the acquirer. | CardPaymentTransactionAdviceResponse6 - Required 1..1 |
| TMSTrigger | Instructions for contacting the terminal management host. | TMSTrigger1 - 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
%% ContentInformationType16 recursion level 0 with max 1
class ContentInformationType16{
ContentType ContentType2Code
}
ContentInformationType16 *-- "1..1" AuthenticatedData5 : AuthenticatedData
%% AuthenticatedData5 recursion level 1 with max 1
class AuthenticatedData5{
Version IsoNumber
MAC IsoMax140Binary
}
AuthenticatedData5 *-- "1..0" IRecipient6Choice : Recipient
AuthenticatedData5 *-- "1..1" AlgorithmIdentification22 : MACAlgorithm
AuthenticatedData5 *-- "1..1" EncapsulatedContent3 : EncapsulatedContent
ContentInformationType16 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). | AuthenticatedData5 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the AcceptorCurrencyConversionAdviceResponseV02 implementation follows a specific implementaiton pattern. First of all, AcceptorCurrencyConversionAdviceResponseV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, AcceptorCurrencyConversionAdviceResponseV02Document implements IOuterDocument. Because AcceptorCurrencyConversionAdviceResponseV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type AcceptorCurrencyConversionAdviceResponseV02.
classDiagram
class IOuterRecord
AcceptorCurrencyConversionAdviceResponseV02 --|> IOuterRecord : Implements
AcceptorCurrencyConversionAdviceResponseV02Document --|> IOuterDocument~AcceptorCurrencyConversionAdviceResponseV02~ : Implements
class IOuterDocument~AcceptorCurrencyConversionAdviceResponseV02~ {
AcceptorCurrencyConversionAdviceResponseV02 Message
}
Document wrapper for serialization
The only real purpose AcceptorCurrencyConversionAdviceResponseV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:caaa.019.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using AcceptorCurrencyConversionAdviceResponseV02.ToDocument() method. The returned AcceptorCurrencyConversionAdviceResponseV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
AcceptorCurrencyConversionAdviceResponseV02Document *-- AcceptorCurrencyConversionAdviceResponseV02 : 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.019.001.02">
<AccptrCcyConvsAdvcRspn>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CcyConvsAdvcRspn>
<!-- CurrencyConversionAdviceResponse inner content -->
</CcyConvsAdvcRspn>
<SctyTrlr>
<!-- SecurityTrailer inner content -->
</SctyTrlr>
</AccptrCcyConvsAdvcRspn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_7RkBods4Eee9e6xduATmQg"
nextVersions="_EdpUMQuiEeqw5uEXxQ9H4g"
previousVersion="_o7sQ1RCFEeeriKqGwDrUEg"
name="AcceptorCurrencyConversionAdviceResponseV02"
definition="The AcceptorCurrencyConversionAdviceResponse message is sent by the service provider to acknowledge the acceptor about the notification of the reception of the currency conversion advice."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="AccptrCcyConvsAdvcRspn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<doclet
xmi:id="_7RkBo9s4Eee9e6xduATmQg"
type="purpose" />
<messageBuildingBlock
xmi:id="_7RkBpds4Eee9e6xduATmQg"
nextVersions="_EdpUNQuiEeqw5uEXxQ9H4g"
previousVersion="_o7sQ1xCFEeeriKqGwDrUEg"
name="Header"
definition="Cancellation advice response message management information."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_LECaAdnHEeeN3v2fup_Shw" />
<messageBuildingBlock
xmi:id="_7RkBp9s4Eee9e6xduATmQg"
nextVersions="_EdpUNwuiEeqw5uEXxQ9H4g"
previousVersion="_o7sQ1hCFEeeriKqGwDrUEg"
name="CurrencyConversionAdviceResponse"
definition="Information related to the currency conversion advice response."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="CcyConvsAdvcRspn"
complexType="_vL5uAdtREee9e6xduATmQg" />
<messageBuildingBlock
xmi:id="_7RkBqds4Eee9e6xduATmQg"
nextVersions="_EdpUOQuiEeqw5uEXxQ9H4g"
previousVersion="_o7sQ2BCFEeeriKqGwDrUEg"
name="SecurityTrailer"
definition="Trailer of the message containing a MAC."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SctyTrlr"
complexType="_Wb7MEds3Eee9e6xduATmQg" />
<messageDefinitionIdentifier
businessArea="caaa"
messageFunctionality="019"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.