auth.027.001.03
The CurrencyControlStatusAdvice message is sent by either the reporting party (respectively the registration agent) or the registration agent (respectively the reporting party) to provide a status advice on a previously sent currency control message.
Usage: The message may be sent in response to requests on the registration of the currency control contract, supporting document or on the payment regulatory information notification.
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
%% CurrencyControlStatusAdviceV03 recursion level 0 with max 0
CurrencyControlStatusAdviceV03 *-- "1..1" CurrencyControlHeader6 : GroupHeader
CurrencyControlStatusAdviceV03 *-- "1..1" CurrencyControlGroupStatus2 : GroupStatus
CurrencyControlStatusAdviceV03 *-- "0..1" CurrencyControlPackageStatus2 : PackageStatus
CurrencyControlStatusAdviceV03 *-- "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 |
GroupStatus building block
Provides the group status for the global message. Provides the currency control group status details. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CurrencyControlGroupStatus2 recursion level 0 with max 1
class CurrencyControlGroupStatus2{
Status StatisticalReportingStatus1Code
StatusDateTime IsoISODateTime
}
CurrencyControlGroupStatus2 *-- "1..1" OriginalMessage5 : OriginalReferences
CurrencyControlGroupStatus2 *-- "1..1" TradeParty5 : ReportingParty
CurrencyControlGroupStatus2 *-- "1..1" BranchAndFinancialInstitutionIdentification6 : RegistrationAgent
CurrencyControlGroupStatus2 *-- "0..1" IPeriod4Choice : ReportingPeriod
CurrencyControlGroupStatus2 *-- "0..0" ValidationStatusReason2 : StatusReason
%% OriginalMessage5 recursion level 1 with max 1
class OriginalMessage5{
OriginalMessageIdentification IsoMax35Text
OriginalMessageNameIdentification IsoMax35Text
OriginalCreationDateTime IsoISODateTime
}
OriginalMessage5 *-- "0..1" IParty40Choice : OriginalSender
%% 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
%% IPeriod4Choice recursion level 1 with max 1
%% ValidationStatusReason2 recursion level 1 with max 1
class ValidationStatusReason2{
AdditionalInformation IsoMax105Text
}
ValidationStatusReason2 *-- "0..1" PartyIdentification135 : Originator
ValidationStatusReason2 *-- "0..1" IStatusReason6Choice : Reason
ValidationStatusReason2 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
CurrencyControlGroupStatus2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalReferences | Original underlying message references for which the status advice is provided. | OriginalMessage5 - 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 |
| ReportingPeriod | For daily reporting this is the day to which the transaction data in the status message refers to. For periodic reporting this is the first and the last day to which the transaction data in the status message refers. | IPeriod4Choice - Optional 0..1 |
| Status | Provides the status for the full report. | StatisticalReportingStatus1Code - Optional 0..1 |
| StatusReason | Provides detailed information on the status reason. | ValidationStatusReason2 - Unknown 0..0 |
| StatusDateTime | Provides the date and time when the status was issued. | IsoISODateTime - Optional 0..1 |
PackageStatus building block
Provides the status of the package in the message, which may contain the individual records. Provides the details of each package of currency control records. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CurrencyControlPackageStatus2 recursion level 0 with max 1
class CurrencyControlPackageStatus2{
PackageIdentification IsoMax35Text
Status StatisticalReportingStatus1Code
StatusDateTime IsoISODateTime
}
CurrencyControlPackageStatus2 *-- "0..0" ValidationStatusReason2 : StatusReason
CurrencyControlPackageStatus2 *-- "0..0" CurrencyControlRecordStatus2 : RecordStatus
%% ValidationStatusReason2 recursion level 1 with max 1
class ValidationStatusReason2{
AdditionalInformation IsoMax105Text
}
ValidationStatusReason2 *-- "0..1" PartyIdentification135 : Originator
ValidationStatusReason2 *-- "0..1" IStatusReason6Choice : Reason
ValidationStatusReason2 *-- "0..0" GenericValidationRuleIdentification1 : ValidationRule
%% CurrencyControlRecordStatus2 recursion level 1 with max 1
class CurrencyControlRecordStatus2{
RecordIdentification IsoMax35Text
Status StatisticalReportingStatus1Code
StatusDateTime IsoISODateTime
}
CurrencyControlRecordStatus2 *-- "0..0" ValidationStatusReason2 : StatusReason
CurrencyControlRecordStatus2 *-- "0..1" DocumentIdentification28 : DocumentIdentification
CurrencyControlPackageStatus2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PackageIdentification | Unique and unambiguous identification of each package of transactions and optionally the entry/record within the package of transactions. | IsoMax35Text - Required 1..1 |
| Status | Defines the status of the reported transaction. | StatisticalReportingStatus1Code - Required 1..1 |
| StatusReason | Provides detailed information on the status reason. | ValidationStatusReason2 - Unknown 0..0 |
| StatusDateTime | Provides the date and time when the status was issued. | IsoISODateTime - Optional 0..1 |
| RecordStatus | Provides the status of the individual records in the package. | CurrencyControlRecordStatus2 - 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 CurrencyControlStatusAdviceV03 implementation follows a specific implementaiton pattern. First of all, CurrencyControlStatusAdviceV03 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CurrencyControlStatusAdviceV03Document implements IOuterDocument. Because CurrencyControlStatusAdviceV03 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CurrencyControlStatusAdviceV03.
classDiagram
class IOuterRecord
CurrencyControlStatusAdviceV03 --|> IOuterRecord : Implements
CurrencyControlStatusAdviceV03Document --|> IOuterDocument~CurrencyControlStatusAdviceV03~ : Implements
class IOuterDocument~CurrencyControlStatusAdviceV03~ {
CurrencyControlStatusAdviceV03 Message
}
Document wrapper for serialization
The only real purpose CurrencyControlStatusAdviceV03Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:auth.027.001.03’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CurrencyControlStatusAdviceV03.ToDocument() method. The returned CurrencyControlStatusAdviceV03Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CurrencyControlStatusAdviceV03Document *-- CurrencyControlStatusAdviceV03 : 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.027.001.03">
<CcyCtrlStsAdvc>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<GrpSts>
<!-- GroupStatus inner content -->
</GrpSts>
<PackgSts>
<!-- PackageStatus inner content -->
</PackgSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CcyCtrlStsAdvc>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Nz8avx3pEeuiRvbpCaJe6A"
previousVersion="_bf9SA22PEei3KuUgpx7Xcw"
name="CurrencyControlStatusAdviceV03"
definition="The CurrencyControlStatusAdvice message is sent by either the reporting party (respectively the registration agent) or the registration agent (respectively the reporting party) to provide a status advice on a previously sent currency control message.

Usage: 
The message may be sent in response to requests on the registration of the currency control contract, supporting document or on the payment regulatory information notification."
registrationStatus="Registered"
messageSet="_MvlNQM7hEeSdANavIlVXcg"
xmlTag="CcyCtrlStsAdvc"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_Nz8awR3pEeuiRvbpCaJe6A"
previousVersion="_bf9SBW2PEei3KuUgpx7Xcw"
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="_Nz8awx3pEeuiRvbpCaJe6A"
previousVersion="_bf9SB22PEei3KuUgpx7Xcw"
name="GroupStatus"
definition="Provides the group status for the global message."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="GrpSts"
complexType="_S5InHW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_Nz8axR3pEeuiRvbpCaJe6A"
previousVersion="_bf9SCW2PEei3KuUgpx7Xcw"
name="PackageStatus"
definition="Provides the status of the package in the message, which may contain the individual records."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="PackgSts"
complexType="_9WLb9248EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_Nz8axx3pEeuiRvbpCaJe6A"
previousVersion="_bf9SC22PEei3KuUgpx7Xcw"
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="027"
flavour="001"
version="03" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.