auth.023.001.02
The ContractRegistrationStatementRequest message is sent by the reporting party to the registration agent to request for a statement of the operations related to 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
%% ContractRegistrationStatementRequestV02 recursion level 0 with max 0
ContractRegistrationStatementRequestV02 *-- "1..1" CurrencyControlHeader4 : GroupHeader
ContractRegistrationStatementRequestV02 *-- "1..1" ContractRegistrationStatementRequest2 : StatementRequest
ContractRegistrationStatementRequestV02 *-- "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 |
StatementRequest building block
Details on the information requested for the contract registration statement. Details on the statement requested elements. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ContractRegistrationStatementRequest2 recursion level 0 with max 1
class ContractRegistrationStatementRequest2{
StatementRequestIdentification IsoMax35Text
RegisteredContractIdentification IsoMax35Text
}
ContractRegistrationStatementRequest2 *-- "1..1" ReportingPeriod4 : ReportingPeriod
ContractRegistrationStatementRequest2 *-- "1..1" TradeParty5 : ReportingParty
ContractRegistrationStatementRequest2 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
ContractRegistrationStatementRequest2 *-- "0..1" ContractRegistrationStatementCriteria1 : ReturnCriteria
ContractRegistrationStatementRequest2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% ReportingPeriod4 recursion level 1 with max 1
class ReportingPeriod4{
Type QueryType3Code
}
ReportingPeriod4 *-- "1..1" DatePeriod3 : FromToDate
ReportingPeriod4 *-- "1..1" TimePeriod2 : FromToTime
%% 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
%% ContractRegistrationStatementCriteria1 recursion level 1 with max 1
class ContractRegistrationStatementCriteria1{
TransactionJournal IsoTrueFalseIndicator
SupportingDocumentJournal IsoTrueFalseIndicator
AdditionalSupportingDocumentJournal IsoTrueFalseIndicator
RegulatoryRuleValidation IsoTrueFalseIndicator
}
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
ContractRegistrationStatementRequest2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| StatementRequestIdentification | Unique and unambiguous identification of the contract registration statement request. | IsoMax35Text - Required 1..1 |
| ReportingPeriod | Specifies the period for which the statement is requested. | ReportingPeriod4 - 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 |
| RegisteredContractIdentification | Identifies the requested registered contract. | IsoMax35Text - Required 1..1 |
| ReturnCriteria | Defines the criteria to be returned in the statement in response to the request. | ContractRegistrationStatementCriteria1 - 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 ContractRegistrationStatementRequestV02 implementation follows a specific implementaiton pattern. First of all, ContractRegistrationStatementRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, ContractRegistrationStatementRequestV02Document implements IOuterDocument. Because ContractRegistrationStatementRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type ContractRegistrationStatementRequestV02.
classDiagram
class IOuterRecord
ContractRegistrationStatementRequestV02 --|> IOuterRecord : Implements
ContractRegistrationStatementRequestV02Document --|> IOuterDocument~ContractRegistrationStatementRequestV02~ : Implements
class IOuterDocument~ContractRegistrationStatementRequestV02~ {
ContractRegistrationStatementRequestV02 Message
}
Document wrapper for serialization
The only real purpose ContractRegistrationStatementRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.023.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using ContractRegistrationStatementRequestV02.ToDocument() method. The returned ContractRegistrationStatementRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
ContractRegistrationStatementRequestV02Document *-- ContractRegistrationStatementRequestV02 : 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.023.001.02">
<CtrctRegnStmtReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<StmtReq>
<!-- StatementRequest inner content -->
</StmtReq>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CtrctRegnStmtReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_bf9R422PEei3KuUgpx7Xcw"
nextVersions="_Nz8apx3pEeuiRvbpCaJe6A"
previousVersion="_Jk0bkNnQEeS--7IJLPC9lw"
name="ContractRegistrationStatementRequestV02"
definition="The ContractRegistrationStatementRequest message is sent by the reporting party to the registration agent to request for a statement of the operations related to the registered contract subject to currency control."
registrationStatus="Registered"
messageSet="__ju0gDh7Eeqhm8z1jMmfeA"
xmlTag="CtrctRegnStmtReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_bf9R5W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8aqR3pEeuiRvbpCaJe6A"
previousVersion="_SlntsdnQEeS--7IJLPC9lw"
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="_bf9R522PEei3KuUgpx7Xcw"
nextVersions="_Nz8aqx3pEeuiRvbpCaJe6A"
previousVersion="_BWDgAuFHEeStTblywAGIyA"
name="StatementRequest"
definition="Details on the information requested for the contract registration statement."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="StmtReq"
complexType="_Nl-rYW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9R6W2PEei3KuUgpx7Xcw"
nextVersions="_Nz8arR3pEeuiRvbpCaJe6A"
previousVersion="_s4EGwdnQEeS--7IJLPC9lw"
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="023"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.