reda.072.001.01
The RequestToPayDebtorActivationCancellationRequest message is sent by the debtor RTP (Request To Pay) provider to the creditor RTP provider and optionally from the debtor to its RTP provider and from the creditor RTP provider to the creditor to request for the cancellation of the debtor activation of the RTP service with that specific creditor.
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
%% RequestToPayDebtorActivationCancellationRequestV01 recursion level 0 with max 0
RequestToPayDebtorActivationCancellationRequestV01 *-- "1..1" ActivationHeader2 : Header
RequestToPayDebtorActivationCancellationRequestV01 *-- "1..1" DebtorActivationCancellation2 : CancellationData
RequestToPayDebtorActivationCancellationRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
Header 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. Specifies the identification and parties playing a role in a request to pay service management message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ActivationHeader2 recursion level 0 with max 1
class ActivationHeader2{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
ActivationHeader2 *-- "0..1" RTPPartyIdentification1 : MessageOriginator
ActivationHeader2 *-- "0..1" RTPPartyIdentification1 : MessageRecipient
ActivationHeader2 *-- "1..1" RTPPartyIdentification1 : InitiatingParty
%% RTPPartyIdentification1 recursion level 1 with max 1
class RTPPartyIdentification1{
Name IsoMax140Text
CountryOfResidence CountryCode
}
RTPPartyIdentification1 *-- "0..1" PostalAddress24 : PostalAddress
RTPPartyIdentification1 *-- "0..1" IParty49Choice : Identification
RTPPartyIdentification1 *-- "0..1" Contact4 : ContactDetails
%% RTPPartyIdentification1 recursion level 1 with max 1
class RTPPartyIdentification1{
Name IsoMax140Text
CountryOfResidence CountryCode
}
RTPPartyIdentification1 *-- "0..1" PostalAddress24 : PostalAddress
RTPPartyIdentification1 *-- "0..1" IParty49Choice : Identification
RTPPartyIdentification1 *-- "0..1" Contact4 : ContactDetails
%% RTPPartyIdentification1 recursion level 1 with max 1
class RTPPartyIdentification1{
Name IsoMax140Text
CountryOfResidence CountryCode
}
RTPPartyIdentification1 *-- "0..1" PostalAddress24 : PostalAddress
RTPPartyIdentification1 *-- "0..1" IParty49Choice : Identification
RTPPartyIdentification1 *-- "0..1" Contact4 : ContactDetails
ActivationHeader2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference assigned by the instructing party and sent to the next party in the chain 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. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
| MessageOriginator | Party that sends the message. | RTPPartyIdentification1 - Optional 0..1 |
| MessageRecipient | Party that receives the message. | RTPPartyIdentification1 - Optional 0..1 |
| InitiatingParty | Party that initiates the message. This can either be the debtor himself or the party that initiates the request on behalf of the debtor. | RTPPartyIdentification1 - Required 1..1 |
CancellationData building block
Provides details on the debtor activation cancellation request. Identifies the creditor enrolment to be cancelled. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% DebtorActivationCancellation2 recursion level 0 with max 1
DebtorActivationCancellation2 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
DebtorActivationCancellation2 *-- "0..1" DebtorActivationCancellationReason2 : CancellationReason
DebtorActivationCancellation2 *-- "1..1" IOriginalActivation2Choice : OriginalActivation
DebtorActivationCancellation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
%% DebtorActivationCancellationReason2 recursion level 1 with max 1
class DebtorActivationCancellationReason2{
AdditionalInformation IsoMax105Text
}
DebtorActivationCancellationReason2 *-- "0..1" RTPPartyIdentification1 : Originator
DebtorActivationCancellationReason2 *-- "1..1" IDebtorActivationCancellationReason1Choice : Reason
%% IOriginalActivation2Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
DebtorActivationCancellation2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalBusinessInstruction | Unique identification of the original instruction. | OriginalBusinessInstruction1 - Optional 0..1 |
| CancellationReason | Provides detailed information on the cancellation reason. | DebtorActivationCancellationReason2 - Optional 0..1 |
| OriginalActivation | Provides the original activation data. | IOriginalActivation2Choice - 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 RequestToPayDebtorActivationCancellationRequestV01 implementation follows a specific implementaiton pattern. First of all, RequestToPayDebtorActivationCancellationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestToPayDebtorActivationCancellationRequestV01Document implements IOuterDocument. Because RequestToPayDebtorActivationCancellationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestToPayDebtorActivationCancellationRequestV01.
classDiagram
class IOuterRecord
RequestToPayDebtorActivationCancellationRequestV01 --|> IOuterRecord : Implements
RequestToPayDebtorActivationCancellationRequestV01Document --|> IOuterDocument~RequestToPayDebtorActivationCancellationRequestV01~ : Implements
class IOuterDocument~RequestToPayDebtorActivationCancellationRequestV01~ {
RequestToPayDebtorActivationCancellationRequestV01 Message
}
Document wrapper for serialization
The only real purpose RequestToPayDebtorActivationCancellationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.072.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RequestToPayDebtorActivationCancellationRequestV01.ToDocument() method. The returned RequestToPayDebtorActivationCancellationRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RequestToPayDebtorActivationCancellationRequestV01Document *-- RequestToPayDebtorActivationCancellationRequestV01 : 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:reda.072.001.01">
<ReqToPayDbtrActvtnCxlReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlData>
<!-- CancellationData inner content -->
</CxlData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ReqToPayDbtrActvtnCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rNNBw-HzEeqbls7Gk4-ckA"
name="RequestToPayDebtorActivationCancellationRequestV01"
definition="The RequestToPayDebtorActivationCancellationRequest message is sent by the debtor RTP (Request To Pay) provider to the creditor RTP provider and optionally from the debtor to its RTP provider and from the creditor RTP provider to the creditor to request for the cancellation of the debtor activation of the RTP service with that specific creditor."
registrationStatus="Registered"
messageSet="_6PO9tOHwEeqbls7Gk4-ckA"
xmlTag="ReqToPayDbtrActvtnCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_rNNBxeHzEeqbls7Gk4-ckA"
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="_rNNBx-HzEeqbls7Gk4-ckA"
name="Header"
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="Hdr"
complexType="_UUIee-H7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNByeHzEeqbls7Gk4-ckA"
name="CancellationData"
definition="Provides details on the debtor activation cancellation request."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="CxlData"
complexType="_UVRG6-H7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNBy-HzEeqbls7Gk4-ckA"
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="reda"
messageFunctionality="072"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.