auth.026.001.02
The CurrencyControlRequestOrLetter message is sent by the reporting party (respectively the registration agent) to the registration agent (respectively the reporting party) to send a currency control related letter or to request for supporting documents.
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
%% CurrencyControlRequestOrLetterV02 recursion level 0 with max 0
CurrencyControlRequestOrLetterV02 *-- "1..1" CurrencyControlHeader5 : GroupHeader
CurrencyControlRequestOrLetterV02 *-- "1..1" SupportingDocumentRequestOrLetter2 : RequestOrLetter
CurrencyControlRequestOrLetterV02 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Characteristics shared by all individual items included in the message. Characteristics shared by all individual items included in the currency control message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CurrencyControlHeader5 recursion level 0 with max 1
class CurrencyControlHeader5{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfItems IsoMax15NumericText
}
CurrencyControlHeader5 *-- "1..1" IParty40Choice : InitiatingParty
CurrencyControlHeader5 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
%% IParty40Choice recursion level 1 with max 1
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
CurrencyControlHeader5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the instructing party, and sent to the next party in the chain to unambiguously identify the message. | Usage: The instructing party has to make sure that MessageIdentification is unique per instructed party for a pre-agreed period. |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| NumberOfItems | Number of individual items contained in the message. | IsoMax15NumericText - Required 1..1 |
| InitiatingParty | Party that initiates the instruction. | IParty40Choice - Required 1..1 |
| ForwardingAgent | Agent which forwards the message. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
RequestOrLetter building block
Supporting document request or letter details. Currency control related document or letter supporting the contract registration. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupportingDocumentRequestOrLetter2 recursion level 0 with max 1
class SupportingDocumentRequestOrLetter2{
RequestOrLetterIdentification IsoMax35Text
Date IsoISODate
Subject IsoMax140Text
Type SupportDocumentType1Code
Description IsoMax1025Text
ResponseRequired IsoTrueFalseIndicator
DueDate IsoISODate
}
SupportingDocumentRequestOrLetter2 *-- "0..1" IParty40Choice : Sender
SupportingDocumentRequestOrLetter2 *-- "0..1" IParty40Choice : Receiver
SupportingDocumentRequestOrLetter2 *-- "0..0" OriginalMessage4 : OriginalReferences
SupportingDocumentRequestOrLetter2 *-- "0..0" DocumentGeneralInformation3 : Attachment
SupportingDocumentRequestOrLetter2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% IParty40Choice recursion level 1 with max 1
%% IParty40Choice recursion level 1 with max 1
%% OriginalMessage4 recursion level 1 with max 1
class OriginalMessage4{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
OriginalPackageIdentification IsoMax35Text
OriginalRecordIdentification IsoMax35Text
}
OriginalMessage4 *-- "0..1" IParty40Choice : OriginalSender
%% DocumentGeneralInformation3 recursion level 1 with max 1
class DocumentGeneralInformation3{
DocumentType ExternalDocumentType1Code
DocumentNumber IsoMax35Text
SenderReceiverSequenceIdentification IsoMax140Text
IssueDate IsoISODate
URL IsoMax256Text
}
DocumentGeneralInformation3 *-- "0..1" IsoSignatureEnvelopeReference : LinkFileHash
DocumentGeneralInformation3 *-- "1..1" BinaryFile1 : AttachedBinaryFile
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
SupportingDocumentRequestOrLetter2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RequestOrLetterIdentification | Unique and unambiguous identification of the supporting document request or the letter. | IsoMax35Text - Required 1..1 |
| Date | Date of the supporting document request or the letter. | IsoISODate - Optional 0..1 |
| Sender | Sender of the request or letter. | IParty40Choice - Optional 0..1 |
| Receiver | Receiver of the request or letter. | IParty40Choice - Optional 0..1 |
| OriginalReferences | Provides the references of the original underlying message(s) for which supporting documents are requested or for which the letter is sent. | OriginalMessage4 - Unknown 0..0 |
| Subject | Subject of the letter or supporting document. | IsoMax140Text - Required 1..1 |
| Type | Provides the type of supporting document requested. | SupportDocumentType1Code - Required 1..1 |
| Description | Further free format description of the request. | IsoMax1025Text - Optional 0..1 |
| ResponseRequired | Flag to indicate whether a response is required or not. Usage: when the request is used to send a letter, there is no response required. | IsoTrueFalseIndicator - Required 1..1 |
| DueDate | Date by which the response to the request is expected. | IsoISODate - Optional 0..1 |
| Attachment | Documents provided as attachments to the supporting document request or letter. | DocumentGeneralInformation3 - Unknown 0..0 |
| SupplementaryData | Additional information that cannot be captured in the structured elements and/or any other specific block. | SupplementaryData1 - Unknown 0..0 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the CurrencyControlRequestOrLetterV02 implementation follows a specific implementaiton pattern. First of all, CurrencyControlRequestOrLetterV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CurrencyControlRequestOrLetterV02Document implements IOuterDocument. Because CurrencyControlRequestOrLetterV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CurrencyControlRequestOrLetterV02.
classDiagram
class IOuterRecord
CurrencyControlRequestOrLetterV02 --|> IOuterRecord : Implements
CurrencyControlRequestOrLetterV02Document --|> IOuterDocument~CurrencyControlRequestOrLetterV02~ : Implements
class IOuterDocument~CurrencyControlRequestOrLetterV02~ {
CurrencyControlRequestOrLetterV02 Message
}
Document wrapper for serialization
The only real purpose CurrencyControlRequestOrLetterV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.026.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CurrencyControlRequestOrLetterV02.ToDocument() method. The returned CurrencyControlRequestOrLetterV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CurrencyControlRequestOrLetterV02Document *-- CurrencyControlRequestOrLetterV02 : 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:auth.026.001.02">
<CcyCtrlReqOrLttr>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<ReqOrLttr>
<!-- RequestOrLetter inner content -->
</ReqOrLttr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CcyCtrlReqOrLttr>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_bf9R-22PEei3KuUgpx7Xcw"
nextVersions="_Nz8atx3pEeuiRvbpCaJe6A"
previousVersion="_c5_V8NnPEeS--7IJLPC9lw"
name="CurrencyControlRequestOrLetterV02"
definition="The CurrencyControlRequestOrLetter message is sent by the reporting party (respectively the registration agent) to the registration agent (respectively the reporting party) to send a currency control related letter or to request for supporting documents."
registrationStatus="Registered"
messageSet="__ju0gDh7Eeqhm8z1jMmfeA"
xmlTag="CcyCtrlReqOrLttr"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_bf9R_W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8auR3pEeuiRvbpCaJe6A"
previousVersion="_RN_MYdnQEeS--7IJLPC9lw"
name="GroupHeader"
definition="Characteristics shared by all individual items included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_9DQf9W48EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9R_22PEei3KuUgpx7Xcw"
nextVersions="_Nz8aux3pEeuiRvbpCaJe6A"
previousVersion="_ioRR9dnQEeS--7IJLPC9lw"
name="RequestOrLetter"
definition="Supporting document request or letter details."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="ReqOrLttr"
complexType="_LUGvaW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9SAW2PEei3KuUgpx7Xcw"
nextVersions="_Nz8avR3pEeuiRvbpCaJe6A"
previousVersion="_rp31UdnQEeS--7IJLPC9lw"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="auth"
messageFunctionality="026"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.