pain.017.001.02
Scope The MandateCopyRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor. The MandateCopyRequest message is forwarded by the agent of the initiator to the agent of the counterparty. A MandateCopyRequest message is used to request a copy of an existing mandate. If accepted, the mandate copy can be sent using the MandateAcceptanceReport message. Usage The MandateCopyRequest message can contain one or more copy requests. The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent. The message can also be used by an initiating party that has authority to send the message on behalf of the creditor or debtor. The MandateCopyRequest message can be used in domestic and cross-border scenarios.
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
%% MandateCopyRequestV02 recursion level 0 with max 0
MandateCopyRequestV02 *-- "1..1" GroupHeader80 : GroupHeader
MandateCopyRequestV02 *-- "1..1" MandateCopy2 : UnderlyingCopyRequestDetails
MandateCopyRequestV02 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics to identify the message and parties playing a role in the mandate copy request, but which are not part of the mandate. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% GroupHeader80 recursion level 0 with max 1
class GroupHeader80{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
GroupHeader80 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader80 *-- "0..1" PartyIdentification135 : InitiatingParty
GroupHeader80 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructingAgent
GroupHeader80 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : InstructedAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% 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
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
GroupHeader80 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the instructing party, and sent to the instructed party, 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 |
| Authorisation | User identification or any user key to be used to check the authority of the initiating party. | |
| InitiatingParty | Party that initiates the mandate message. | PartyIdentification135 - Optional 0..1 |
| InstructingAgent | Agent that instructs the next party in the chain to carry out an instruction. | |
| InstructedAgent | Agent that is instructed by the previous party in the chain to carry out an instruction. |
UnderlyingCopyRequestDetails building block
Set of information used to identify the mandate for which a copy is requested. Identifies the mandate, for which a copy of the details is requested. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MandateCopy2 recursion level 0 with max 1
MandateCopy2 *-- "0..1" OriginalMessageInformation1 : OriginalMessageInformation
MandateCopy2 *-- "1..1" IOriginalMandate6Choice : OriginalMandate
MandateCopy2 *-- "0..1" IMandateStatus1Choice : MandateStatus
MandateCopy2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalMessageInformation1 recursion level 1 with max 1
class OriginalMessageInformation1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
%% IOriginalMandate6Choice recursion level 1 with max 1
%% IMandateStatus1Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
MandateCopy2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalMessageInformation | Provides information on the original message. | OriginalMessageInformation1 - Optional 0..1 |
| OriginalMandate | Provides the original mandate data. | IOriginalMandate6Choice - Required 1..1 |
| MandateStatus | Indicates the status of the mandate. | IMandateStatus1Choice - 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 MandateCopyRequestV02 implementation follows a specific implementaiton pattern. First of all, MandateCopyRequestV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MandateCopyRequestV02Document implements IOuterDocument. Because MandateCopyRequestV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MandateCopyRequestV02.
classDiagram
class IOuterRecord
MandateCopyRequestV02 --|> IOuterRecord : Implements
MandateCopyRequestV02Document --|> IOuterDocument~MandateCopyRequestV02~ : Implements
class IOuterDocument~MandateCopyRequestV02~ {
MandateCopyRequestV02 Message
}
Document wrapper for serialization
The only real purpose MandateCopyRequestV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.017.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MandateCopyRequestV02.ToDocument() method. The returned MandateCopyRequestV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MandateCopyRequestV02Document *-- MandateCopyRequestV02 : 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:pain.017.001.02">
<MndtCpyReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<UndrlygCpyReqDtls>
<!-- UnderlyingCopyRequestDetails inner content -->
</UndrlygCpyReqDtls>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</MndtCpyReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_bf9SO22PEei3KuUgpx7Xcw"
nextVersions="_rUYOHdcBEeq_l4BJLVUF2Q"
previousVersion="_fptHIG6qEeaUkthD_kt0tA"
name="MandateCopyRequestV02"
definition="Scope
The MandateCopyRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor.
The MandateCopyRequest message is forwarded by the agent of the initiator to the agent of the counterparty.
A MandateCopyRequest message is used to request a copy of an existing mandate. If accepted, the mandate copy can be sent using the MandateAcceptanceReport message.
Usage
The MandateCopyRequest message can contain one or more copy requests.
The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent.
The message can also be used by an initiating party that has authority to send the message on behalf of the creditor or debtor.
The MandateCopyRequest message can be used in domestic and cross-border scenarios.
"
registrationStatus="Registered"
messageSet="_wRx2wU2rEeG_I4xRYCA_7g"
xmlTag="MndtCpyReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_bf9SPW2PEei3KuUgpx7Xcw"
nextVersions="_rUYOH9cBEeq_l4BJLVUF2Q"
previousVersion="_QakmoX5lEea7cqFPsAF3tQ"
name="SupplementaryDataRule"
definition="The SupplementaryData building block at message level must not be used to provide additional information about a transaction. The SupplementaryData element at transaction level should be used for that purpose."
registrationStatus="Provisionally Registered" />
<messageBuildingBlock
xmi:id="_bf9SP22PEei3KuUgpx7Xcw"
nextVersions="_rUYOJ9cBEeq_l4BJLVUF2Q"
previousVersion="_9EgQ4G6tEeaUkthD_kt0tA"
name="GroupHeader"
definition="Set of characteristics to identify the message and parties playing a role in the mandate copy request, but which are not part of the mandate."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_G-MfEW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9SQW2PEei3KuUgpx7Xcw"
nextVersions="_rUYOKdcBEeq_l4BJLVUF2Q"
previousVersion="_WQnekG6vEeaUkthD_kt0tA"
name="UnderlyingCopyRequestDetails"
definition="Set of information used to identify the mandate for which a copy is requested."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="UndrlygCpyReqDtls"
complexType="_RSUaQW49EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_bf9SQ22PEei3KuUgpx7Xcw"
nextVersions="_rUYOK9cBEeq_l4BJLVUF2Q"
previousVersion="_eHtPQW6yEeaUkthD_kt0tA"
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="pain"
messageFunctionality="017"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.