pain.011.001.05
Scope The MandateCancellationRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor. The MandateCancellationRequest message is forwarded by the agent of the initiator to the agent of the counterparty. A MandateCancellationRequest message is used to request the cancellation of an existing mandate. If accepted, this MandateCancellationRequest message together with the MandateAcceptanceReport message confirming the acceptance will be considered a valid cancellation of an existing mandate, agreed upon by all parties. Usage The MandateCancellationRequest message can contain one or more request(s) to cancel a specific mandate. 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 MandateCancellationRequest 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
%% MandateCancellationRequestV05 recursion level 0 with max 0
MandateCancellationRequestV05 *-- "1..1" GroupHeader47 : GroupHeader
MandateCancellationRequestV05 *-- "1..1" MandateCancellation5 : UnderlyingCancellationDetails
MandateCancellationRequestV05 *-- "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 cancellation of the mandate, 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. |
UnderlyingCancellationDetails building block
Set of elements used to provide details on the cancellation request. Identifies the mandate to be cancelled. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MandateCancellation5 recursion level 0 with max 1
MandateCancellation5 *-- "0..1" OriginalMessageInformation1 : OriginalMessageInformation
MandateCancellation5 *-- "1..1" PaymentCancellationReason1 : CancellationReason
MandateCancellation5 *-- "1..1" IOriginalMandate4Choice : OriginalMandate
MandateCancellation5 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalMessageInformation1 recursion level 1 with max 1
class OriginalMessageInformation1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
%% PaymentCancellationReason1 recursion level 1 with max 1
class PaymentCancellationReason1{
AdditionalInformation IsoMax105Text
}
PaymentCancellationReason1 *-- "0..1" PartyIdentification43 : Originator
PaymentCancellationReason1 *-- "1..1" IMandateReason1Choice : Reason
%% IOriginalMandate4Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
MandateCancellation5 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalMessageInformation | Provides information on the original message. | OriginalMessageInformation1 - Optional 0..1 |
| CancellationReason | Provides detailed information on the cancellation reason. | PaymentCancellationReason1 - 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 MandateCancellationRequestV05 implementation follows a specific implementaiton pattern. First of all, MandateCancellationRequestV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MandateCancellationRequestV05Document implements IOuterDocument. Because MandateCancellationRequestV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MandateCancellationRequestV05.
classDiagram
class IOuterRecord
MandateCancellationRequestV05 --|> IOuterRecord : Implements
MandateCancellationRequestV05Document --|> IOuterDocument~MandateCancellationRequestV05~ : Implements
class IOuterDocument~MandateCancellationRequestV05~ {
MandateCancellationRequestV05 Message
}
Document wrapper for serialization
The only real purpose MandateCancellationRequestV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.011.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MandateCancellationRequestV05.ToDocument() method. The returned MandateCancellationRequestV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MandateCancellationRequestV05Document *-- MandateCancellationRequestV05 : 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.011.001.05">
<MndtCxlReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<UndrlygCxlDtls>
<!-- UnderlyingCancellationDetails inner content -->
</UndrlygCxlDtls>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</MndtCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_di0QoUjuEeaVLL5QKJ4f-A"
nextVersions="_bf9SJ22PEei3KuUgpx7Xcw"
previousVersion="_Ie2IVRPeEeSVo-TFVwFHvA"
name="MandateCancellationRequestV05"
definition="Scope
The MandateCancellationRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor.
The MandateCancellationRequest message is forwarded by the agent of the initiator to the agent of the counterparty.
A MandateCancellationRequest message is used to request the cancellation of an existing mandate. If accepted, this MandateCancellationRequest message together with the MandateAcceptanceReport message confirming the acceptance will be considered a valid cancellation of an existing mandate, agreed upon by all parties.
Usage
The MandateCancellationRequest message can contain one or more request(s) to cancel a specific mandate.
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 MandateCancellationRequest message can be used in domestic and cross-border scenarios."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="MndtCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_di0Qo0juEeaVLL5QKJ4f-A"
nextVersions="_bf9SKW2PEei3KuUgpx7Xcw"
previousVersion="_Ie2IVxPeEeSVo-TFVwFHvA"
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="_di0QpUjuEeaVLL5QKJ4f-A"
nextVersions="_bf9SK22PEei3KuUgpx7Xcw"
previousVersion="_Ie2IWRPeEeSVo-TFVwFHvA"
name="GroupHeader"
definition="Set of characteristics to identify the message and parties playing a role in the cancellation of the mandate, but which are not part of the mandate."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_s3oCIFkyEeGeoaLUQk__nA_-839305610" />
<messageBuildingBlock
xmi:id="_di0Qp0juEeaVLL5QKJ4f-A"
nextVersions="_bf9SLW2PEei3KuUgpx7Xcw"
previousVersion="_Ie2IWxPeEeSVo-TFVwFHvA"
name="UnderlyingCancellationDetails"
definition="Set of elements used to provide details on the cancellation request."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="UndrlygCxlDtls"
complexType="_dBASSUjwEeaVLL5QKJ4f-A" />
<messageBuildingBlock
xmi:id="_di0QqUjuEeaVLL5QKJ4f-A"
nextVersions="_bf9SL22PEei3KuUgpx7Xcw"
previousVersion="_Ie2IXRPeEeSVo-TFVwFHvA"
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="011"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.