reda.068.001.01
The RequestToPayCreditorEnrolmentCancellationRequest message is sent by the creditor RTP (Request To Pay) provider to an RTP directory provider and optionally by the creditor to a creditor RTP provider to request for the cancellation of the creditor registration in the RTP directory. The message may also be forwarded to any authorised third party, as defined in the local scheme
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
%% RequestToPayCreditorEnrolmentCancellationRequestV01 recursion level 0 with max 0
RequestToPayCreditorEnrolmentCancellationRequestV01 *-- "1..1" EnrolmentHeader2 : Header
RequestToPayCreditorEnrolmentCancellationRequestV01 *-- "1..1" CreditorEnrolmentCancellation2 : CancellationData
RequestToPayCreditorEnrolmentCancellationRequestV01 *-- "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 creditor enrolment. Specifies the header information for the creditor enrolment. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% EnrolmentHeader2 recursion level 0 with max 1
class EnrolmentHeader2{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
EnrolmentHeader2 *-- "0..1" RTPPartyIdentification1 : MessageOriginator
EnrolmentHeader2 *-- "0..1" RTPPartyIdentification1 : MessageRecipient
EnrolmentHeader2 *-- "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
EnrolmentHeader2 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 creditor himself or the party that initiates the request on behalf of the creditor. | RTPPartyIdentification1 - Required 1..1 |
CancellationData building block
Set of elements used to provide details on the cancellation request. Identifies the creditor enrolment to be cancelled. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% CreditorEnrolmentCancellation2 recursion level 0 with max 1
CreditorEnrolmentCancellation2 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
CreditorEnrolmentCancellation2 *-- "0..1" CreditorEnrolmentCancellationReason2 : CancellationReason
CreditorEnrolmentCancellation2 *-- "1..1" IOriginalEnrolment2Choice : OriginalEnrolment
CreditorEnrolmentCancellation2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
%% CreditorEnrolmentCancellationReason2 recursion level 1 with max 1
class CreditorEnrolmentCancellationReason2{
AdditionalInformation IsoMax105Text
}
CreditorEnrolmentCancellationReason2 *-- "0..1" RTPPartyIdentification1 : Originator
CreditorEnrolmentCancellationReason2 *-- "1..1" ICreditorEnrolmentCancellationReason1Choice : Reason
%% IOriginalEnrolment2Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
CreditorEnrolmentCancellation2 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. | CreditorEnrolmentCancellationReason2 - Optional 0..1 |
| OriginalEnrolment | Provides the original creditor enrolment data. | IOriginalEnrolment2Choice - 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 RequestToPayCreditorEnrolmentCancellationRequestV01 implementation follows a specific implementaiton pattern. First of all, RequestToPayCreditorEnrolmentCancellationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestToPayCreditorEnrolmentCancellationRequestV01Document implements IOuterDocument. Because RequestToPayCreditorEnrolmentCancellationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestToPayCreditorEnrolmentCancellationRequestV01.
classDiagram
class IOuterRecord
RequestToPayCreditorEnrolmentCancellationRequestV01 --|> IOuterRecord : Implements
RequestToPayCreditorEnrolmentCancellationRequestV01Document --|> IOuterDocument~RequestToPayCreditorEnrolmentCancellationRequestV01~ : Implements
class IOuterDocument~RequestToPayCreditorEnrolmentCancellationRequestV01~ {
RequestToPayCreditorEnrolmentCancellationRequestV01 Message
}
Document wrapper for serialization
The only real purpose RequestToPayCreditorEnrolmentCancellationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.068.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RequestToPayCreditorEnrolmentCancellationRequestV01.ToDocument() method. The returned RequestToPayCreditorEnrolmentCancellationRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RequestToPayCreditorEnrolmentCancellationRequestV01Document *-- RequestToPayCreditorEnrolmentCancellationRequestV01 : 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.068.001.01">
<ReqToPayCdtrEnrlmntCxlReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<CxlData>
<!-- CancellationData inner content -->
</CxlData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ReqToPayCdtrEnrlmntCxlReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rNNBm-HzEeqbls7Gk4-ckA"
name="RequestToPayCreditorEnrolmentCancellationRequestV01"
definition="The RequestToPayCreditorEnrolmentCancellationRequest message is sent by the creditor RTP (Request To Pay) provider to an RTP directory provider and optionally by the creditor to a creditor RTP provider to request for the cancellation of the creditor registration in the RTP directory. 
The message may also be forwarded to any authorised third party, as defined in the local scheme"
registrationStatus="Registered"
messageSet="_6PO9tOHwEeqbls7Gk4-ckA"
xmlTag="ReqToPayCdtrEnrlmntCxlReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_rNNBneHzEeqbls7Gk4-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="_rNNBn-HzEeqbls7Gk4-ckA"
name="Header"
definition="Set of characteristics to identify the message and parties playing a role in the cancellation of the creditor enrolment."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_US8LoeH7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNBoeHzEeqbls7Gk4-ckA"
name="CancellationData"
definition="Set of elements used to provide details on the cancellation request."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="CxlData"
complexType="_UedfLeH7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNBo-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="068"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.