MandateCopyRequestV01

pain.017.001.01

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
%% MandateCopyRequestV01 recursion level 0 with max 0
MandateCopyRequestV01 *-- "1..1" GroupHeader47 : GroupHeader
MandateCopyRequestV01 *-- "1..1" MandateCopy1 : UnderlyingCopyRequestDetails
MandateCopyRequestV01 *-- "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
%% GroupHeader47 recursion level 0 with max 1
class GroupHeader47{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
GroupHeader47 *-- "0..2" IAuthorisation1Choice : Authorisation
GroupHeader47 *-- "0..1" PartyIdentification43 : InitiatingParty
GroupHeader47 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent
GroupHeader47 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent
%% IAuthorisation1Choice recursion level 1 with max 1
%% PartyIdentification43 recursion level 1 with max 1
class PartyIdentification43{
    Name IsoMax140Text
    CountryOfResidence CountryCode
}
PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress
PartyIdentification43 *-- "0..1" IParty11Choice : Identification
PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
%% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification

GroupHeader47 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.	PartyIdentification43 - 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
%% MandateCopy1 recursion level 0 with max 1
MandateCopy1 *-- "0..1" OriginalMessageInformation1 : OriginalMessageInformation
MandateCopy1 *-- "1..1" IOriginalMandate4Choice : OriginalMandate
MandateCopy1 *-- "0..1" IMandateStatus1Choice : MandateStatus
MandateCopy1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalMessageInformation1 recursion level 1 with max 1
class OriginalMessageInformation1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
%% IOriginalMandate4Choice 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

MandateCopy1 members

Member name	Description	Data Type / Multiplicity
OriginalMessageInformation	Provides information on the original message.	OriginalMessageInformation1 - Optional 0..1
OriginalMandate	Provides the original mandate data.	IOriginalMandate4Choice - 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 MandateCopyRequestV01 implementation follows a specific implementaiton pattern. First of all, MandateCopyRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MandateCopyRequestV01Document implements IOuterDocument. Because MandateCopyRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MandateCopyRequestV01.

classDiagram
    class IOuterRecord
    MandateCopyRequestV01 --|> IOuterRecord : Implements
    MandateCopyRequestV01Document --|> IOuterDocument~MandateCopyRequestV01~ : Implements
    class IOuterDocument~MandateCopyRequestV01~ {
        MandateCopyRequestV01 Message
     }

Document wrapper for serialization

The only real purpose MandateCopyRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.017.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MandateCopyRequestV01.ToDocument() method. The returned MandateCopyRequestV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    MandateCopyRequestV01Document *-- MandateCopyRequestV01 : 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.01">
    <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="_fptHIG6qEeaUkthD_kt0tA"
  nextVersions="_bf9SO22PEei3KuUgpx7Xcw"
  name="MandateCopyRequestV01"
  definition="Scope&#xD;&#xA;The MandateCopyRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor.&#xD;&#xA;The MandateCopyRequest message is forwarded by the agent of the initiator to the agent of the counterparty.&#xD;&#xA;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.&#xD;&#xA;Usage&#xD;&#xA;The MandateCopyRequest message can contain one or more copy requests.&#xD;&#xA;The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent.&#xD;&#xA;The message can also be used by an initiating party that has authority to send the message on behalf of the creditor or debtor.&#xD;&#xA;The MandateCopyRequest message can be used in domestic and cross-border scenarios.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="MndtCpyReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_QakmoX5lEea7cqFPsAF3tQ"
    nextVersions="_bf9SPW2PEei3KuUgpx7Xcw"
    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="_9EgQ4G6tEeaUkthD_kt0tA"
    nextVersions="_bf9SP22PEei3KuUgpx7Xcw"
    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="_s3oCIFkyEeGeoaLUQk__nA_-839305610" />
  <messageBuildingBlock
    xmi:id="_WQnekG6vEeaUkthD_kt0tA"
    nextVersions="_bf9SQW2PEei3KuUgpx7Xcw"
    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="_fytnkH5gEea7cqFPsAF3tQ" />
  <messageBuildingBlock
    xmi:id="_eHtPQW6yEeaUkthD_kt0tA"
    nextVersions="_bf9SQ22PEei3KuUgpx7Xcw"
    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="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.