auth.025.001.02
The CurrencyControlSupportingDocumentDelivery message is sent by either the reporting party (respectively the registration agent) or the registration agent (respectively the reporting party) in response to the supporting document request.
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
%% CurrencyControlSupportingDocumentDeliveryV02 recursion level 0 with max 0
CurrencyControlSupportingDocumentDeliveryV02 *-- "1..1" CurrencyControlHeader5 : GroupHeader
CurrencyControlSupportingDocumentDeliveryV02 *-- "1..1" SupportingDocument2 : SupportingDocument
CurrencyControlSupportingDocumentDeliveryV02 *-- "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 |
SupportingDocument building block
Details of the supporting document provided for the registered contract. Currency control document supporting the contract registration. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupportingDocument2 recursion level 0 with max 1
class SupportingDocument2{
SupportingDocumentIdentification IsoMax35Text
OriginalRequestIdentification IsoMax35Text
}
SupportingDocument2 *-- "1..1" DocumentIdentification28 : Certificate
SupportingDocument2 *-- "1..1" PartyIdentification135 : AccountOwner
SupportingDocument2 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : AccountServicer
SupportingDocument2 *-- "0..1" DocumentAmendment1 : Amendment
SupportingDocument2 *-- "1..1" IContractRegistrationReference1Choice : ContractReference
SupportingDocument2 *-- "1..0" SupportingDocumentEntry1 : Entry
SupportingDocument2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% DocumentIdentification28 recursion level 1 with max 1
class DocumentIdentification28{
Identification IsoMax35Text
DateOfIssue IsoISODate
}
%% PartyIdentification135 recursion level 1 with max 1
class PartyIdentification135{
Name IsoMax140Text
CountryOfResidence CountryCode
}
PartyIdentification135 *-- "0..1" PostalAddress24 : PostalAddress
PartyIdentification135 *-- "0..1" IParty38Choice : Identification
PartyIdentification135 *-- "0..1" Contact4 : ContactDetails
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% DocumentAmendment1 recursion level 1 with max 1
class DocumentAmendment1{
CorrectionIdentification IsoNumber
OriginalDocumentIdentification IsoMax35Text
}
%% IContractRegistrationReference1Choice recursion level 1 with max 1
%% SupportingDocumentEntry1 recursion level 1 with max 1
class SupportingDocumentEntry1{
EntryIdentification IsoMax35Text
DocumentType IsoExact4AlphaNumericText
TotalAmount IsoActiveCurrencyAndAmount
TotalAmountAfterShipment IsoActiveCurrencyAndAmount
TotalAmountInContractCurrency IsoActiveCurrencyAndAmount
TotalAmountAfterShipmentInContractCurrency IsoActiveCurrencyAndAmount
AdditionalInformation IsoMax500Text
}
SupportingDocumentEntry1 *-- "1..1" DocumentIdentification22 : OriginalDocument
SupportingDocumentEntry1 *-- "1..1" ShipmentAttribute1 : ShipmentAttributes
SupportingDocumentEntry1 *-- "0..0" DocumentGeneralInformation3 : Attachment
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
SupportingDocument2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| SupportingDocumentIdentification | Unique and unambiguous identification of the supporting document. | IsoMax35Text - Required 1..1 |
| OriginalRequestIdentification | Unique identification of the original query message. | IsoMax35Text - Optional 0..1 |
| Certificate | Unique identification of the certificate for which the supporting document is provided. | DocumentIdentification28 - Required 1..1 |
| AccountOwner | Party that legally owns the cash account. | PartyIdentification135 - Required 1..1 |
| AccountServicer | Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. | BranchAndFinancialInstitutionIdentification6 - Required 1..1 |
| Amendment | Amendment indicator details. | DocumentAmendment1 - Optional 0..1 |
| ContractReference | Reference of the registered contract or the underlying contract for the supporting documents. | IContractRegistrationReference1Choice - Required 1..1 |
| Entry | Individual entry of the supporting document. | SupportingDocumentEntry1 - Unknown 1..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 CurrencyControlSupportingDocumentDeliveryV02 implementation follows a specific implementaiton pattern. First of all, CurrencyControlSupportingDocumentDeliveryV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CurrencyControlSupportingDocumentDeliveryV02Document implements IOuterDocument. Because CurrencyControlSupportingDocumentDeliveryV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CurrencyControlSupportingDocumentDeliveryV02.
classDiagram
class IOuterRecord
CurrencyControlSupportingDocumentDeliveryV02 --|> IOuterRecord : Implements
CurrencyControlSupportingDocumentDeliveryV02Document --|> IOuterDocument~CurrencyControlSupportingDocumentDeliveryV02~ : Implements
class IOuterDocument~CurrencyControlSupportingDocumentDeliveryV02~ {
CurrencyControlSupportingDocumentDeliveryV02 Message
}
Document wrapper for serialization
The only real purpose CurrencyControlSupportingDocumentDeliveryV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.025.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CurrencyControlSupportingDocumentDeliveryV02.ToDocument() method. The returned CurrencyControlSupportingDocumentDeliveryV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CurrencyControlSupportingDocumentDeliveryV02Document *-- CurrencyControlSupportingDocumentDeliveryV02 : 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.025.001.02">
<CcyCtrlSpprtgDocDlvry>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<SpprtgDoc>
<!-- SupportingDocument inner content -->
</SpprtgDoc>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CcyCtrlSpprtgDocDlvry>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_bf9R822PEei3KuUgpx7Xcw"
nextVersions="_Nz8ayR3pEeuiRvbpCaJe6A"
previousVersion="_5RUDUNLpEeSDLevdaFPXHw"
name="CurrencyControlSupportingDocumentDeliveryV02"
definition="The CurrencyControlSupportingDocumentDelivery message is sent by either the reporting party (respectively the registration agent) or the registration agent (respectively the reporting party) in response to the supporting document request."
registrationStatus="Registered"
messageSet="__ju0gDh7Eeqhm8z1jMmfeA"
xmlTag="CcyCtrlSpprtgDocDlvry"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_bf9R9W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8ayx3pEeuiRvbpCaJe6A"
previousVersion="_AKIVQNLqEeSDLevdaFPXHw"
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="_bf9R922PEei3KuUgpx7Xcw"
nextVersions="_Nz8azR3pEeuiRvbpCaJe6A"
previousVersion="_9sPhENLqEeSDLevdaFPXHw"
name="SupportingDocument"
definition="Details of the supporting document provided for the registered contract."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="SpprtgDoc"
complexType="_6emK1248EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9R-W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8azx3pEeuiRvbpCaJe6A"
previousVersion="_CltKYdLrEeSDLevdaFPXHw"
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="025"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.