auth.021.001.03
The ContractRegistrationAmendmentRequest message is sent by the reporting party to the registration agent to amend 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
%% ContractRegistrationAmendmentRequestV03 recursion level 0 with max 0
ContractRegistrationAmendmentRequestV03 *-- "1..1" CurrencyControlHeader4 : GroupHeader
ContractRegistrationAmendmentRequestV03 *-- "1..1" RegisteredContract13 : ContractRegistrationAmendment
ContractRegistrationAmendmentRequestV03 *-- "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 |
ContractRegistrationAmendment building block
Details on the amendment of the registered contract. Amendment data of 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
%% RegisteredContract13 recursion level 0 with max 1
class RegisteredContract13{
ContractRegistrationAmendmentIdentification IsoMax35Text
}
RegisteredContract13 *-- "1..1" TradeParty5 : ReportingParty
RegisteredContract13 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
RegisteredContract13 *-- "1..0" RegisteredContract14 : RegisteredContractAmendment
RegisteredContract13 *-- "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
%% RegisteredContract14 recursion level 1 with max 1
class RegisteredContract14{
RegisteredContractAmendmentIdentification IsoMax35Text
OriginalRegisteredContractIdentification IsoMax35Text
Priority Priority2Code
AdditionalInformation IsoMax1025Text
}
RegisteredContract14 *-- "1..1" IUnderlyingContract3Choice : Contract
RegisteredContract14 *-- "0..0" ContractBalance1 : ContractBalance
RegisteredContract14 *-- "0..1" IPaymentScheduleType2Choice : PaymentScheduleType
RegisteredContract14 *-- "0..0" DocumentGeneralInformation5 : Attachment
RegisteredContract14 *-- "0..0" SupplementaryData1 : SupplementaryData
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
RegisteredContract13 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ContractRegistrationAmendmentIdentification | Unique and unambiguous identification of the contract registration amendment. | IsoMax35Text - Required 1..1 |
| ReportingParty | Party registering the currency control contract. | TradeParty5 - Required 1..1 |
| RegistrationAgent | Agent which registers the currency control contract. | BranchAndFinancialInstitutionIdentification6 - Required 1..1 |
| RegisteredContractAmendment | Amendment details applied on one or several registered contracts. | RegisteredContract14 - 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 ContractRegistrationAmendmentRequestV03 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationAmendmentRequestV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationAmendmentRequestV03Document implements IOuterDocument. Because ContractRegistrationAmendmentRequestV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationAmendmentRequestV03.
classDiagram
class IOuterRecord
ContractRegistrationAmendmentRequestV03 --|> IOuterRecord : Implements
ContractRegistrationAmendmentRequestV03Document --|> IOuterDocument~ContractRegistrationAmendmentRequestV03~ : Implements
class IOuterDocument~ContractRegistrationAmendmentRequestV03~ {
ContractRegistrationAmendmentRequestV03 Message
}
Document wrapper for serialization
The only real purpose ContractRegistrationAmendmentRequestV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.021.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ContractRegistrationAmendmentRequestV03.ToDocument() method. The returned ContractRegistrationAmendmentRequestV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ContractRegistrationAmendmentRequestV03Document *-- ContractRegistrationAmendmentRequestV03 : 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.021.001.03">
<CtrctRegnAmdmntReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<CtrctRegnAmdmnt>
<!-- ContractRegistrationAmendment inner content -->
</CtrctRegnAmdmnt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CtrctRegnAmdmntReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Nz8agR3pEeuiRvbpCaJe6A"
previousVersion="_bf9R022PEei3KuUgpx7Xcw"
name="ContractRegistrationAmendmentRequestV03"
definition="The ContractRegistrationAmendmentRequest message is sent by the reporting party to the registration agent to amend the registered contract subject to currency control."
registrationStatus="Registered"
messageSet="_MvlNQM7hEeSdANavIlVXcg"
xmlTag="CtrctRegnAmdmntReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Nz8agx3pEeuiRvbpCaJe6A"
previousVersion="_bf9R1W2PEei3KuUgpx7Xcw"
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="_Nz8ahR3pEeuiRvbpCaJe6A"
previousVersion="_bf9R122PEei3KuUgpx7Xcw"
name="ContractRegistrationAmendment"
definition="Details on the amendment of the registered contract."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="CtrctRegnAmdmnt"
complexType="_Nx-C4bGJEeuSTr8k0UEM8A" />
<messageBuildingBlock
xmi:id="_Nz8ahx3pEeuiRvbpCaJe6A"
previousVersion="_bf9R2W2PEei3KuUgpx7Xcw"
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="021"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.