reda.069.001.01
The RequestToPayCreditorEnrolmentStatusReport message is sent from the RTP (Request To Pay) directory provider to the creditor RTP provider and optionally from the creditor RTP provider to the creditor or any of the forwarding agent to provide the status of the initial creation, amendment or cancellation request.
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
%% RequestToPayCreditorEnrolmentStatusReportV01 recursion level 0 with max 0
RequestToPayCreditorEnrolmentStatusReportV01 *-- "1..1" EnrolmentHeader2 : Header
RequestToPayCreditorEnrolmentStatusReportV01 *-- "1..1" EnrolmentStatus2 : OriginalEnrolmentAndStatus
RequestToPayCreditorEnrolmentStatusReportV01 *-- "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 status report 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 |
OriginalEnrolmentAndStatus building block
Status of the creditor enrolment instruction (that is request, amendment or cancellation). Specifies the status of a creditor enrolment. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% EnrolmentStatus2 recursion level 0 with max 1
EnrolmentStatus2 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
EnrolmentStatus2 *-- "1..1" IServiceStatus1Choice : Status
EnrolmentStatus2 *-- "0..1" CreditorEnrolmentStatusReason2 : StatusReason
EnrolmentStatus2 *-- "0..1" IOriginalEnrolment2Choice : OriginalEnrolmentReference
EnrolmentStatus2 *-- "0..1" IDateAndDateTime2Choice : EffectiveEnrolmentDate
EnrolmentStatus2 *-- "0..0" SupplementaryData1 : SupplementaryData
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
MessageIdentification IsoMax35Text
MessageNameIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
%% IServiceStatus1Choice recursion level 1 with max 1
%% CreditorEnrolmentStatusReason2 recursion level 1 with max 1
class CreditorEnrolmentStatusReason2{
AdditionalInformation IsoMax105Text
}
CreditorEnrolmentStatusReason2 *-- "0..1" RTPPartyIdentification1 : Originator
CreditorEnrolmentStatusReason2 *-- "1..1" ICreditorEnrolmentStatusReason2Choice : Reason
%% IOriginalEnrolment2Choice recursion level 1 with max 1
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% SupplementaryData1 recursion level 1 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
EnrolmentStatus2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| OriginalBusinessInstruction | Unique identification of the original instruction. | OriginalBusinessInstruction1 - Optional 0..1 |
| Status | Provides detailed information on the status for the request. | IServiceStatus1Choice - Required 1..1 |
| StatusReason | Specifies the reason for the status of the enrolment request. | CreditorEnrolmentStatusReason2 - Optional 0..1 |
| OriginalEnrolmentReference | Provides the original creditor enrolment data. | IOriginalEnrolment2Choice - Optional 0..1 |
| EffectiveEnrolmentDate | Actual date when the creditor enrolment was executed. | IDateAndDateTime2Choice - 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 RequestToPayCreditorEnrolmentStatusReportV01 implementation follows a specific implementaiton pattern. First of all, RequestToPayCreditorEnrolmentStatusReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestToPayCreditorEnrolmentStatusReportV01Document implements IOuterDocument. Because RequestToPayCreditorEnrolmentStatusReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestToPayCreditorEnrolmentStatusReportV01.
classDiagram
class IOuterRecord
RequestToPayCreditorEnrolmentStatusReportV01 --|> IOuterRecord : Implements
RequestToPayCreditorEnrolmentStatusReportV01Document --|> IOuterDocument~RequestToPayCreditorEnrolmentStatusReportV01~ : Implements
class IOuterDocument~RequestToPayCreditorEnrolmentStatusReportV01~ {
RequestToPayCreditorEnrolmentStatusReportV01 Message
}
Document wrapper for serialization
The only real purpose RequestToPayCreditorEnrolmentStatusReportV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.069.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RequestToPayCreditorEnrolmentStatusReportV01.ToDocument() method. The returned RequestToPayCreditorEnrolmentStatusReportV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RequestToPayCreditorEnrolmentStatusReportV01Document *-- RequestToPayCreditorEnrolmentStatusReportV01 : 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.069.001.01">
<ReqToPayCdtrEnrlmntStsRpt>
<Hdr>
<!-- Header inner content -->
</Hdr>
<OrgnlEnrlmntAndSts>
<!-- OriginalEnrolmentAndStatus inner content -->
</OrgnlEnrlmntAndSts>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ReqToPayCdtrEnrlmntStsRpt>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rNNBr-HzEeqbls7Gk4-ckA"
name="RequestToPayCreditorEnrolmentStatusReportV01"
definition="The RequestToPayCreditorEnrolmentStatusReport message is sent from the RTP (Request To Pay) directory provider to the creditor RTP provider and optionally from the creditor RTP provider to the creditor or any of the forwarding agent to provide the status of the initial creation, amendment or cancellation request."
registrationStatus="Registered"
messageSet="_6PO9tOHwEeqbls7Gk4-ckA"
xmlTag="ReqToPayCdtrEnrlmntStsRpt"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_rNNBseHzEeqbls7Gk4-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="_rNNBs-HzEeqbls7Gk4-ckA"
name="Header"
definition="Set of characteristics to identify the message and parties playing a role in the status report of the creditor enrolment."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_US8LoeH7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNBteHzEeqbls7Gk4-ckA"
name="OriginalEnrolmentAndStatus"
definition="Status of the creditor enrolment instruction (that is request, amendment or cancellation)."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="OrgnlEnrlmntAndSts"
complexType="_UalrzeH7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNBt-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="069"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.