ContractRegistrationConfirmationV02

auth.019.001.02

The ContractRegistrationConfirmation message is sent by the registration agent to the reporting party to register the 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
%% ContractRegistrationConfirmationV02 recursion level 0 with max 0
ContractRegistrationConfirmationV02 *-- "1..1" CurrencyControlHeader6 : GroupHeader
ContractRegistrationConfirmationV02 *-- "1..1" RegisteredContract7 : RegisteredContract
ContractRegistrationConfirmationV02 *-- "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
%% CurrencyControlHeader6 recursion level 0 with max 1
class CurrencyControlHeader6{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    NumberOfItems IsoMax15NumericText
}
CurrencyControlHeader6 *-- "1..1" PartyIdentification135 : ReceivingParty
CurrencyControlHeader6 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
%% 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
  

CurrencyControlHeader6 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
ReceivingParty Party that receives the message. PartyIdentification135 - Required 1..1
RegistrationAgent Agent which sends the message. BranchAndFinancialInstitutionIdentification6 - Required 1..1

RegisteredContract building block

Identifies the contract details which is registered for currency control. 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
%% RegisteredContract7 recursion level 0 with max 1
class RegisteredContract7{
    OriginalContractRegistrationRequest IsoMax35Text
    LoanPrincipalAmount IsoActiveCurrencyAndAmount
    EstimatedDateIndicator IsoTrueFalseIndicator
    InterCompanyLoan IsoTrueFalseIndicator
    AdditionalInformation IsoMax1025Text
}
RegisteredContract7 *-- "1..1" TradeParty5 : ReportingParty
RegisteredContract7 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
RegisteredContract7 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : IssuerFinancialInstitution
RegisteredContract7 *-- "1..1" IUnderlyingContract2Choice : Contract
RegisteredContract7 *-- "0..0" ContractBalance1 : ContractBalance
RegisteredContract7 *-- "0..1" IPaymentScheduleType1Choice : PaymentScheduleType
RegisteredContract7 *-- "1..1" DocumentIdentification29 : RegisteredContractIdentification
RegisteredContract7 *-- "0..1" DocumentIdentification22 : PreviousRegisteredContractIdentification
RegisteredContract7 *-- "0..0" RegisteredContractJournal2 : RegisteredContractJournal
RegisteredContract7 *-- "0..0" RegisteredContractAmendment1 : Amendment
RegisteredContract7 *-- "1..1" RegisteredContractCommunication1 : Submission
RegisteredContract7 *-- "1..1" RegisteredContractCommunication1 : Delivery
RegisteredContract7 *-- "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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% IUnderlyingContract2Choice recursion level 1 with max 1
%% ContractBalance1 recursion level 1 with max 1
class ContractBalance1{
    Amount IsoActiveCurrencyAndAmount
    CreditDebitIndicator CreditDebit3Code
}
ContractBalance1 *-- "1..1" IContractBalanceType1Choice : Type
%% IPaymentScheduleType1Choice recursion level 1 with max 1
%% DocumentIdentification29 recursion level 1 with max 1
class DocumentIdentification29{
    Identification IsoMax35Text
    DateOfIssue IsoISODate
}
%% DocumentIdentification22 recursion level 1 with max 1
class DocumentIdentification22{
    Identification IsoMax35Text
    DateOfIssue IsoISODate
}
%% RegisteredContractJournal2 recursion level 1 with max 1
class RegisteredContractJournal2{
    ClosureDate IsoISODate
}
RegisteredContractJournal2 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
RegisteredContractJournal2 *-- "0..1" DocumentIdentification28 : UniqueIdentification
RegisteredContractJournal2 *-- "1..1" IContractClosureReason1Choice : ClosureReason
%% RegisteredContractAmendment1 recursion level 1 with max 1
class RegisteredContractAmendment1{
    AmendmentDate IsoISODate
    StartDate IsoISODate
    AmendmentReason IsoMax35Text
    AdditionalInformation IsoMax1025Text
}
RegisteredContractAmendment1 *-- "1..1" DocumentIdentification28 : Document
%% RegisteredContractCommunication1 recursion level 1 with max 1
class RegisteredContractCommunication1{
    Method CommunicationMethod4Code
    Date IsoISODate
}
%% RegisteredContractCommunication1 recursion level 1 with max 1
class RegisteredContractCommunication1{
    Method CommunicationMethod4Code
    Date IsoISODate
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
  

RegisteredContract7 members

Member name Description Data Type / Multiplicity
OriginalContractRegistrationRequest Unique identification of the contract registration creation, amendment or closure request. IsoMax35Text - Optional 0..1
ReportingParty Party registering the currency control contract. TradeParty5 - Required 1..1
RegistrationAgent Agent which registers the currency control contract. BranchAndFinancialInstitutionIdentification6 - Required 1..1
IssuerFinancialInstitution Financial institution of the issuer of the contract. BranchAndFinancialInstitutionIdentification6 - Required 1..1
Contract Details of the contract being registered. IUnderlyingContract2Choice - Required 1..1
ContractBalance Contract balance on date of contract registration. ContractBalance1 - Unknown 0..0
PaymentScheduleType Type of the payment schedule provided in the contract. IPaymentScheduleType1Choice - Optional 0..1
RegisteredContractIdentification Unique and unambiguous identification of the registered contract as assigned by the registration agent. DocumentIdentification29 - Required 1..1
PreviousRegisteredContractIdentification Identification of a previously defined registered contract linked to the same underlying contract. Usage: This is the identification of a previous contract registration for the same underlying contract, which was closed. In most cases, this is used when a reporting party moves from one registration agent to another. DocumentIdentification22 - Optional 0..1
RegisteredContractJournal Journal of previously closed registered contracts for the same underlying contract, which were requested at the same registration agent. RegisteredContractJournal2 - Unknown 0..0
Amendment Details on amendments to the registered contract. RegisteredContractAmendment1 - Unknown 0..0
Submission Provides the communication method for the submission of the registered contract. RegisteredContractCommunication1 - Required 1..1
Delivery Provides the communication method for the delivery of the registered contract. RegisteredContractCommunication1 - Required 1..1
LoanPrincipalAmount Amount of money the borrower pays back to the lender outside of interests and charges. Usage: Only applicable for loan contracts. IsoActiveCurrencyAndAmount - Optional 0..1
EstimatedDateIndicator Indicates whether the dates provided are estimates or not. IsoTrueFalseIndicator - Required 1..1
InterCompanyLoan Indicates whether loan in which both the lender and the borrower are divisions of the same corporation or not. Usage: Only applicable for loan contracts. IsoTrueFalseIndicator - Required 1..1
AdditionalInformation Further information on the registered contract. IsoMax1025Text - Optional 0..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 ContractRegistrationConfirmationV02 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationConfirmationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationConfirmationV02Document implements IOuterDocument. Because ContractRegistrationConfirmationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationConfirmationV02.

classDiagram
    class IOuterRecord
    ContractRegistrationConfirmationV02 --|> IOuterRecord : Implements
    ContractRegistrationConfirmationV02Document --|> IOuterDocument~ContractRegistrationConfirmationV02~ : Implements
    class IOuterDocument~ContractRegistrationConfirmationV02~ {
        ContractRegistrationConfirmationV02 Message
     }
  

Document wrapper for serialization

The only real purpose ContractRegistrationConfirmationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.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 ContractRegistrationConfirmationV02.ToDocument() method. The returned ContractRegistrationConfirmationV02Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    ContractRegistrationConfirmationV02Document *-- ContractRegistrationConfirmationV02 : 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.019.001.02">
    <CtrctRegnConf>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <RegdCtrct>
            <!-- RegisteredContract inner content -->
        </RegdCtrct>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CtrctRegnConf>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_bf9RvW2PEei3KuUgpx7Xcw"
  nextVersions="_Nz8alx3pEeuiRvbpCaJe6A"
  previousVersion="_4iURgNL4EeSDLevdaFPXHw"
  name="ContractRegistrationConfirmationV02"
  definition="The ContractRegistrationConfirmation message is sent by the registration agent to the reporting party to register the contract subject to currency control."
  registrationStatus="Registered"
  messageSet="__ju0gDh7Eeqhm8z1jMmfeA"
  xmlTag="CtrctRegnConf"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_bf9Rv22PEei3KuUgpx7Xcw"
    nextVersions="_Nz8amR3pEeuiRvbpCaJe6A"
    previousVersion="_-eIvsNL4EeSDLevdaFPXHw"
    name="GroupHeader"
    definition="Characteristics shared by all individual items included in the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="GrpHdr"
    complexType="_YW0-0W49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_bf9RwW2PEei3KuUgpx7Xcw"
    nextVersions="_Nz8amx3pEeuiRvbpCaJe6A"
    previousVersion="_4pwWQtL4EeSDLevdaFPXHw"
    name="RegisteredContract"
    definition="Identifies the contract details which is registered for currency control."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="RegdCtrct"
    complexType="_TM868W49EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_bf9Rw22PEei3KuUgpx7Xcw"
    nextVersions="_Nz8anR3pEeuiRvbpCaJe6A"
    previousVersion="_sXEnMdL5EeSDLevdaFPXHw"
    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="019"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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