Iso20022

ContractRegistrationRequestV01

auth.018.001.01

The ContractRegistrationRequest message is sent by the reporting party to the registration agent to initiate the registration of a new 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
%% ContractRegistrationRequestV01 recursion level 0 with max 0
ContractRegistrationRequestV01 *-- "1..1" CurrencyControlHeader1 : GroupHeader
ContractRegistrationRequestV01 *-- "1..1" ContractRegistration1 : ContractRegistration
ContractRegistrationRequestV01 *-- "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
%% CurrencyControlHeader1 recursion level 0 with max 1
class CurrencyControlHeader1{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfItems IsoMax15NumericText
}
CurrencyControlHeader1 *-- "1..1" PartyIdentification77 : InitiatingParty
CurrencyControlHeader1 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : ForwardingAgent
%% PartyIdentification77 recursion level 1 with max 1
class PartyIdentification77{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification77 *-- "0..1" PostalAddress19 : PostalAddress
PartyIdentification77 *-- "0..1" IParty11Choice : Identification
PartyIdentification77 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification

CurrencyControlHeader1 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. PartyIdentification77 - Required 1..1
ForwardingAgent Agent which forwards the message. BranchAndFinancialInstitutionIdentification5 - Optional 0..1

ContractRegistration building block

Identifies the currency control contract details for which the registration is requested. Currency control contract registration details. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ContractRegistration1 recursion level 0 with max 1
class ContractRegistration1{
    ContractRegistrationIdentification IsoMax35Text
}
ContractRegistration1 *-- "1..1" TradeParty2 : ReportingParty
ContractRegistration1 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : RegistrationAgent
ContractRegistration1 *-- "1..0" ContractRegistration2 : ContractRegistrationOpening
ContractRegistration1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% TradeParty2 recursion level 1 with max 1
TradeParty2 *-- "1..1" PartyIdentification77 : PartyIdentification
TradeParty2 *-- "0..1" LegalOrganisation2 : LegalOrganisation
TradeParty2 *-- "0..0" TaxParty3 : TaxParty
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% ContractRegistration2 recursion level 1 with max 1
class ContractRegistration2{
    ContractRegistrationOpeningIdentification IsoMax35Text
    Priority Priority2Code
    AdditionalInformation IsoMax1025Text
}
ContractRegistration2 *-- "1..1" IUnderlyingContract1Choice : Contract
ContractRegistration2 *-- "0..0" ContractBalance1 : ContractBalance
ContractRegistration2 *-- "0..1" IPaymentScheduleType1Choice : PaymentScheduleType
ContractRegistration2 *-- "0..0" DocumentIdentification22 : PreviousRegistrationIdentification
ContractRegistration2 *-- "0..0" DocumentGeneralInformation3 : Attachment
ContractRegistration2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

ContractRegistration1 members

Member name Description Data Type / Multiplicity
ContractRegistrationIdentification Unique and unambiguous identification of the contract registration. IsoMax35Text - Required 1..1
ReportingParty Party registering the currency control contract. TradeParty2 - Required 1..1
RegistrationAgent Agent which registers the currency control contract. BranchAndFinancialInstitutionIdentification5 - Required 1..1
ContractRegistrationOpening Details about the opening of the contract registration. ContractRegistration2 - 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 ContractRegistrationRequestV01 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationRequestV01Document implements IOuterDocument. Because ContractRegistrationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationRequestV01.

classDiagram
    class IOuterRecord
    ContractRegistrationRequestV01 --|> IOuterRecord : Implements
    ContractRegistrationRequestV01Document --|> IOuterDocument~ContractRegistrationRequestV01~ : Implements
    class IOuterDocument~ContractRegistrationRequestV01~ {
        ContractRegistrationRequestV01 Message
     }

Document wrapper for serialization

The only real purpose ContractRegistrationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.018.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ContractRegistrationRequestV01.ToDocument() method. The returned ContractRegistrationRequestV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ContractRegistrationRequestV01Document *-- ContractRegistrationRequestV01 : 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.018.001.01">
    <CtrctRegnReq>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <CtrctRegn>
            <!-- ContractRegistration inner content -->
        </CtrctRegn>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CtrctRegnReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_2fWxgNLHEeSdq5yU2aaSNw"
  nextVersions="_bf9RtW2PEei3KuUgpx7Xcw"
  name="ContractRegistrationRequestV01"
  definition="The ContractRegistrationRequest message is sent by the reporting party to the registration agent to initiate the registration of a new contract subject to currency control."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CtrctRegnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_UY4mANLIEeSdq5yU2aaSNw"
    nextVersions="_bf9Rt22PEei3KuUgpx7Xcw"
    name="GroupHeader"
    definition="Characteristics shared by all individual items included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_MC9ncdLJEeSdq5yU2aaSNw" />
  <messageBuildingBlock
    xmi:id="_Wc_y0NLIEeSdq5yU2aaSNw"
    nextVersions="_bf9RuW2PEei3KuUgpx7Xcw"
    name="ContractRegistration"
    definition="Identifies the currency control contract details for which the registration is requested."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="CtrctRegn"
    complexType="_wrdDwNLIEeSdq5yU2aaSNw" />
  <messageBuildingBlock
    xmi:id="_FG1DUdLrEeSDLevdaFPXHw"
    nextVersions="_bf9Ru22PEei3KuUgpx7Xcw"
    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="018"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.