auth.020.001.02
The ContractRegistrationClosureRequest message is sent by the reporting party to the registration agent to close the registered contract subject to currency control.
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
%% ContractRegistrationClosureRequestV02 recursion level 0 with max 0
ContractRegistrationClosureRequestV02 *-- "1..1" CurrencyControlHeader4 : GroupHeader
ContractRegistrationClosureRequestV02 *-- "1..1" RegisteredContract6 : RegisteredContractClosure
ContractRegistrationClosureRequestV02 *-- "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
%% CurrencyControlHeader4 recursion level 0 with max 1
class CurrencyControlHeader4{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfItems IsoMax15NumericText
}
CurrencyControlHeader4 *-- "1..1" PartyIdentification135 : InitiatingParty
CurrencyControlHeader4 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : ForwardingAgent
%% 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
CurrencyControlHeader4 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. | PartyIdentification135 - Required 1..1 |
| ForwardingAgent | Agent which forwards the message. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
RegisteredContractClosure building block
Details on the closure of the registered contract. Document that a user must file with an authorised servicer for each contract that involves foreign currency transactions with non residents. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RegisteredContract6 recursion level 0 with max 1
class RegisteredContract6{
RegisteredContractClosureIdentification IsoMax35Text
Priority Priority2Code
}
RegisteredContract6 *-- "1..1" TradeParty5 : ReportingParty
RegisteredContract6 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
RegisteredContract6 *-- "1..1" DocumentIdentification29 : OriginalRegisteredContract
RegisteredContract6 *-- "1..1" IContractClosureReason1Choice : ClosureReason
RegisteredContract6 *-- "0..0" SupplementaryData1 : SupplementaryData
%% TradeParty5 recursion level 1 with max 1
TradeParty5 *-- "1..1" PartyIdentification135 : PartyIdentification
TradeParty5 *-- "0..1" LegalOrganisation2 : LegalOrganisation
TradeParty5 *-- "0..0" TaxParty4 : TaxParty
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% DocumentIdentification29 recursion level 1 with max 1
class DocumentIdentification29{
Identification IsoMax35Text
DateOfIssue IsoISODate
}
%% IContractClosureReason1Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
RegisteredContract6 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RegisteredContractClosureIdentification | Unique and unambiguous identification of the registered contract closure. | IsoMax35Text - Required 1..1 |
| ReportingParty | Party who registered the currency control contract. | TradeParty5 - Required 1..1 |
| RegistrationAgent | Agent who registered the currency control contract. | BranchAndFinancialInstitutionIdentification6 - Required 1..1 |
| OriginalRegisteredContract | Original registered contract identification. | DocumentIdentification29 - Required 1..1 |
| Priority | Priority of the registered contract closure. | Priority2Code - Required 1..1 |
| ClosureReason | Reason of the closure. | IContractClosureReason1Choice - Required 1..1 |
| 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 ContractRegistrationClosureRequestV02 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationClosureRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationClosureRequestV02Document implements IOuterDocument. Because ContractRegistrationClosureRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationClosureRequestV02.
classDiagram
class IOuterRecord
ContractRegistrationClosureRequestV02 --|> IOuterRecord : Implements
ContractRegistrationClosureRequestV02Document --|> IOuterDocument~ContractRegistrationClosureRequestV02~ : Implements
class IOuterDocument~ContractRegistrationClosureRequestV02~ {
ContractRegistrationClosureRequestV02 Message
}
Document wrapper for serialization
The only real purpose ContractRegistrationClosureRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.020.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ContractRegistrationClosureRequestV02.ToDocument() method. The returned ContractRegistrationClosureRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ContractRegistrationClosureRequestV02Document *-- ContractRegistrationClosureRequestV02 : 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.020.001.02">
<CtrctRegnClsrReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<RegdCtrctClsr>
<!-- RegisteredContractClosure inner content -->
</RegdCtrctClsr>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CtrctRegnClsrReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_bf9RxW2PEei3KuUgpx7Xcw"
nextVersions="_Nz8aiR3pEeuiRvbpCaJe6A"
previousVersion="_v30CsNL8EeSDLevdaFPXHw"
name="ContractRegistrationClosureRequestV02"
definition="The ContractRegistrationClosureRequest message is sent by the reporting party to the registration agent to close the registered contract subject to currency control."
registrationStatus="Registered"
messageSet="__ju0gDh7Eeqhm8z1jMmfeA"
xmlTag="CtrctRegnClsrReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_bf9Rx22PEei3KuUgpx7Xcw"
nextVersions="_Nz8aix3pEeuiRvbpCaJe6A"
previousVersion="_DxKLsNL9EeSDLevdaFPXHw"
name="GroupHeader"
definition="Characteristics shared by all individual items included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_73tS0W48EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9RyW2PEei3KuUgpx7Xcw"
nextVersions="_Nz8ajR3pEeuiRvbpCaJe6A"
previousVersion="_HBJVwNL9EeSDLevdaFPXHw"
name="RegisteredContractClosure"
definition="Details on the closure of the registered contract."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="RegdCtrctClsr"
complexType="_EXwBT249EeiU9cctagi5ow">
<semanticMarkup
xmi:id="_bf9Ry22PEei3KuUgpx7Xcw"
type="Synonym">
<elements
xmi:id="_bf9RzW2PEei3KuUgpx7Xcw"
name="context"
value="RU-CMPG" />
<elements
xmi:id="_bf9Rz22PEei3KuUgpx7Xcw"
name="value"
value="Deal Passport Closure" />
</semanticMarkup>
</messageBuildingBlock>
<messageBuildingBlock
xmi:id="_bf9R0W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8alR3pEeuiRvbpCaJe6A"
previousVersion="_-phjQdObEeS75MhTUaTyUQ"
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="020"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.