pacs.029.001.01
The MultilateralSettlementRequest message is sent from an instructing agent to a market infrastructure to settle obligations between their participants using accounts held in a settlement service.
Usage: The MultilateralSettlementRequest message can contain one or more settlement instructions with multiple movements between accounts. By default, all movements present in an individual instruction shall be processed as a batch entry rather than a single entry per individual movement.
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
%% MultilateralSettlementRequestV01 recursion level 0 with max 0
MultilateralSettlementRequestV01 *-- "1..1" GroupHeader104 : GroupHeader
MultilateralSettlementRequestV01 *-- "1..1" MultilateralSettlementRequest2 : SettlementRequest
MultilateralSettlementRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics shared by all individual instructions included in the message. Set of characteristics shared by all individual instructions included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader104 recursion level 0 with max 1
class GroupHeader104{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
NumberOfSettlementRequests IsoMax15NumericText
ControlSum IsoDecimalNumber
}
GroupHeader104 *-- "0..1" SettlementInstruction14 : SettlementInformation
%% SettlementInstruction14 recursion level 1 with max 1
class SettlementInstruction14{
SettlementMethod SettlementMethod2Code
}
SettlementInstruction14 *-- "0..1" CashAccount40 : SettlementAccount
SettlementInstruction14 *-- "0..1" IClearingSystemIdentification3Choice : ClearingSystem
GroupHeader104 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the instructing agent, and sent to the market infrastructure to unambiguously identify the message. Usage: The instructing agent has to make sure that MessageIdentification is unique per market infrastructure for a pre-agreed period. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| NumberOfSettlementRequests | Number of individual settlement requests contained in the message. | IsoMax15NumericText - Required 1..1 |
| ControlSum | Total of all individual amounts included in the message, irrespective of currencies. | IsoDecimalNumber - Optional 0..1 |
| SettlementInformation | Specifies the details on how the settlement of the transaction(s) between the instructing agent and the market infrastructure is completed. | SettlementInstruction14 - Optional 0..1 |
SettlementRequest building block
Set of elements providing information specific to the individual settlement request(s). Provides details specific to the individual settlement instruction(s) included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MultilateralSettlementRequest2 recursion level 0 with max 1
class MultilateralSettlementRequest2{
InstructionIdentification IsoMax35Text
InstructionPriority Priority3Code
SettlementPriority Priority3Code
SettlementCycle IsoMax35Text
NumberOfMovementRecords IsoNumber
}
MultilateralSettlementRequest2 *-- "0..1" SettlementTimeRequest2 : SettlementTimeRequest
MultilateralSettlementRequest2 *-- "2..0" MovementRecord1 : MovementRecord
%% SettlementTimeRequest2 recursion level 1 with max 1
class SettlementTimeRequest2{
CLSTime IsoISOTime
TillTime IsoISOTime
FromTime IsoISOTime
RejectTime IsoISOTime
}
%% MovementRecord1 recursion level 1 with max 1
class MovementRecord1{
Identification IsoMax35Text
SequenceNumber IsoNumber
Reference IsoMax35Text
}
MovementRecord1 *-- "1..1" AmountAndDirection5 : Amount
MovementRecord1 *-- "0..1" PartyIdentification135 : SettlementAgent
MovementRecord1 *-- "0..1" CashAccount40 : SettlementAgentAccount
MovementRecord1 *-- "0..1" PartyIdentification135 : Participant
MovementRecord1 *-- "0..1" CashAccount40 : ParticipantAccount
MultilateralSettlementRequest2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| InstructionIdentification | Unique identification, as assigned by the instructing agent, and sent to the market infrastructure to unambiguously identify the instruction. Usage: The instruction identification is a point to point reference that can be used between the instructing agent and the market infrastructure to refer to the individual instruction. It can be included in several messages related to the instruction. | IsoMax35Text - Required 1..1 |
| InstructionPriority | Indicator of the urgency or order of importance that the instructing agent would like the market infrastructure to apply to the processing of the instruction. Usage: Market practice or bilateral agreement should specify how this element should be used. If this element is not populated and there is no market guidance or bilateral agreement, the priority will be considered as ‘Normal’. | Priority3Code - Optional 0..1 |
| SettlementTimeRequest | Provides information on the requested settlement time(s) of the instruction. | SettlementTimeRequest2 - Optional 0..1 |
| SettlementPriority | Indicator of the urgency or order of importance that the instructing agent would like the market infrastructure to apply to the processing of the settlement instruction. Usage: Market practice or bilateral agreement should specify how this element should be used. If this element is not populated and there is no market guidance or bilateral agreement, the priority will be considered as ‘Normal’. | Priority3Code - Optional 0..1 |
| SettlementCycle | Identification of the settlement cycle in the settlement service. Usage: The SettlementCycle is used to differentiate this multilateral settlement from other multilateral settlements where more than one occurs within a given time period. | IsoMax35Text - Optional 0..1 |
| NumberOfMovementRecords | Indicator of the number of movement records contained in an individual settlement request. | IsoNumber - Optional 0..1 |
| MovementRecord | Credit or debit transaction contained in an individual settlement request. Usage: Number of occurrences of MovementRecord shall always be even. | MovementRecord1 - Unknown 2..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 MultilateralSettlementRequestV01 implementation follows a specific implementaiton pattern. First of all, MultilateralSettlementRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MultilateralSettlementRequestV01Document implements IOuterDocument. Because MultilateralSettlementRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MultilateralSettlementRequestV01.
classDiagram
class IOuterRecord
MultilateralSettlementRequestV01 --|> IOuterRecord : Implements
MultilateralSettlementRequestV01Document --|> IOuterDocument~MultilateralSettlementRequestV01~ : Implements
class IOuterDocument~MultilateralSettlementRequestV01~ {
MultilateralSettlementRequestV01 Message
}
Document wrapper for serialization
The only real purpose MultilateralSettlementRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pacs.029.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MultilateralSettlementRequestV01.ToDocument() method. The returned MultilateralSettlementRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MultilateralSettlementRequestV01Document *-- MultilateralSettlementRequestV01 : 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:pacs.029.001.01">
<MulSttlmReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<SttlmReq>
<!-- SettlementRequest inner content -->
</SttlmReq>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</MulSttlmReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_vsvOgQcYEeyTDbUIoCmuCw"
name="MultilateralSettlementRequestV01"
definition="The MultilateralSettlementRequest message is sent from an instructing agent to a market infrastructure to settle obligations between their participants using accounts held in a settlement service.

Usage: The MultilateralSettlementRequest message can contain one or more settlement instructions with multiple movements between accounts. By default, all movements present in an individual instruction shall be processed as a batch entry rather than a single entry per individual movement."
registrationStatus="Registered"
messageSet="_8XKG0KbdEeu5KoySNFB8Ig"
xmlTag="MulSttlmReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_vsvOgwcYEeyTDbUIoCmuCw"
name="GroupHeader"
definition="Set of characteristics shared by all individual instructions included in the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_7o6soQcYEeyTDbUIoCmuCw" />
<messageBuildingBlock
xmi:id="_vsvOhQcYEeyTDbUIoCmuCw"
name="SettlementRequest"
definition="Set of elements providing information specific to the individual settlement request(s)."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="SttlmReq"
complexType="_I5-6EQcZEeyTDbUIoCmuCw" />
<messageBuildingBlock
xmi:id="_vsvOhwcYEeyTDbUIoCmuCw"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="pacs"
messageFunctionality="029"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.