MandateSuspensionRequestV01

pain.018.001.01

Scope The MandateSuspensionRequest message is sent by the initiator of the request to its agent. The initiator can either be the debtor, debtor agent, creditor or creditor agent. A MandateSuspensionRequest message is used to request the suspension of an existing mandate until the suspension is lifted. Usage The MandateSuspensionRequest message can contain one or more suspension requests. The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent. The MandateSuspensionRequest 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
%% MandateSuspensionRequestV01 recursion level 0 with max 0
MandateSuspensionRequestV01 *-- "1..1" GroupHeader47 : GroupHeader
MandateSuspensionRequestV01 *-- "1..1" MandateSuspension1 : UnderlyingSuspensionDetails
MandateSuspensionRequestV01 *-- "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 suspension 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.

UnderlyingSuspensionDetails building block

Set of elements used to provide information on the suspension request of the mandate. Identifies the mandate, which is being suspended. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MandateSuspension1 recursion level 0 with max 1
class MandateSuspension1{
    SuspensionRequestIdentification IsoMax35Text
}
MandateSuspension1 *-- "0..1" OriginalMessageInformation1 : OriginalMessageInformation
MandateSuspension1 *-- "1..1" MandateSuspensionReason1 : SuspensionReason
MandateSuspension1 *-- "1..1" IOriginalMandate4Choice : OriginalMandate
MandateSuspension1 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalMessageInformation1 recursion level 1 with max 1
class OriginalMessageInformation1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
%% MandateSuspensionReason1 recursion level 1 with max 1
class MandateSuspensionReason1{
    AdditionalInformation IsoMax105Text
}
MandateSuspensionReason1 *-- "0..1" PartyIdentification43 : Originator
MandateSuspensionReason1 *-- "1..1" IMandateSuspensionReason1Choice : Reason
%% IOriginalMandate4Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
    PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope

MandateSuspension1 members

Member name	Description	Data Type / Multiplicity
SuspensionRequestIdentification	Unique identification, as assigned by the initiating party, to unambiguously identify the suspension request.	IsoMax35Text - Required 1..1
OriginalMessageInformation	Provides information on the original message.	OriginalMessageInformation1 - Optional 0..1
SuspensionReason	Provides detailed information on the suspension reason.	MandateSuspensionReason1 - Required 1..1
OriginalMandate	Provides the original mandate data.	IOriginalMandate4Choice - Required 1..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 MandateSuspensionRequestV01 implementation follows a specific implementaiton pattern. First of all, MandateSuspensionRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MandateSuspensionRequestV01Document implements IOuterDocument. Because MandateSuspensionRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MandateSuspensionRequestV01.

classDiagram
    class IOuterRecord
    MandateSuspensionRequestV01 --|> IOuterRecord : Implements
    MandateSuspensionRequestV01Document --|> IOuterDocument~MandateSuspensionRequestV01~ : Implements
    class IOuterDocument~MandateSuspensionRequestV01~ {
        MandateSuspensionRequestV01 Message
     }

Document wrapper for serialization

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

classDiagram
    MandateSuspensionRequestV01Document *-- MandateSuspensionRequestV01 : 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.018.001.01">
    <MndtSspnsnReq>
        <GrpHdr>
            <!-- GroupHeader inner content -->
        </GrpHdr>
        <UndrlygSspnsnDtls>
            <!-- UnderlyingSuspensionDetails inner content -->
        </UndrlygSspnsnDtls>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </MndtSspnsnReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_0HNCMH5lEea7cqFPsAF3tQ"
  nextVersions="_bf9SRW2PEei3KuUgpx7Xcw"
  name="MandateSuspensionRequestV01"
  definition="Scope&#xD;&#xA;The MandateSuspensionRequest message is sent by the initiator of the request to its agent. The initiator can either be the debtor, debtor agent, creditor or creditor agent.&#xD;&#xA;A MandateSuspensionRequest message is used to request the suspension of an existing mandate until the suspension is lifted. &#xD;&#xA;Usage&#xD;&#xA;The MandateSuspensionRequest message can contain one or more suspension 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 MandateSuspensionRequest message can be used in domestic and cross-border scenarios.&#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="MndtSspnsnReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_V-wEEX5pEea7cqFPsAF3tQ"
    nextVersions="_bf9SR22PEei3KuUgpx7Xcw"
    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="_SNAisH5nEea7cqFPsAF3tQ"
    nextVersions="_bf9SSW2PEei3KuUgpx7Xcw"
    name="GroupHeader"
    definition="Set of characteristics to identify the message and parties playing a role in the mandate suspension 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="_ka8SwH5nEea7cqFPsAF3tQ"
    nextVersions="_bf9SS22PEei3KuUgpx7Xcw"
    name="UnderlyingSuspensionDetails"
    definition="Set of elements used to provide information on the suspension request of the mandate."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="UndrlygSspnsnDtls"
    complexType="_IgCRoH5oEea7cqFPsAF3tQ" />
  <messageBuildingBlock
    xmi:id="_yoO34H5nEea7cqFPsAF3tQ"
    nextVersions="_bf9STW2PEei3KuUgpx7Xcw"
    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="018"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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