RequestToPayDebtorActivationStatusReportV01

reda.073.001.01

The RequestToPayDebtorActivationStatusReport message is sent from the recipient of the debtor activation request message (initiation, amendment or cancellation), such as the creditor RTP provider or the creditor, to the initiator of the debtor activation request message (debtor, debtor RTP provider or any of the forwarding agent) to provide the status of the 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
%% RequestToPayDebtorActivationStatusReportV01 recursion level 0 with max 0
RequestToPayDebtorActivationStatusReportV01 *-- "1..1" ActivationHeader2 : Header
RequestToPayDebtorActivationStatusReportV01 *-- "1..1" ActivationStatus2 : OriginalActivationAndStatus
RequestToPayDebtorActivationStatusReportV01 *-- "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 mandate acceptance, 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

OriginalActivationAndStatus building block

Status of the debtor activation instruction (that is request, amendment or cancellation). Specifies the status of a debtor activation. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ActivationStatus2 recursion level 0 with max 1
ActivationStatus2 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
ActivationStatus2 *-- "1..1" IServiceStatus1Choice : Status
ActivationStatus2 *-- "0..1" DebtorActivationStatusReason2 : StatusReason
ActivationStatus2 *-- "0..1" IOriginalActivation2Choice : OriginalActivationReference
ActivationStatus2 *-- "0..1" IDateAndDateTime2Choice : EffectiveActivationDate
ActivationStatus2 *-- "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
%% DebtorActivationStatusReason2 recursion level 1 with max 1
class DebtorActivationStatusReason2{
    AdditionalInformation IsoMax105Text
}
DebtorActivationStatusReason2 *-- "0..1" RTPPartyIdentification1 : Originator
DebtorActivationStatusReason2 *-- "1..1" IDebtorActivationStatusReason1Choice : Reason
%% IOriginalActivation2Choice 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

ActivationStatus2 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 of the request.	IServiceStatus1Choice - Required 1..1
StatusReason	Specifies the reason for the status of the debtor activation request.	DebtorActivationStatusReason2 - Optional 0..1
OriginalActivationReference	Provides the reference of the original activation request.	IOriginalActivation2Choice - Optional 0..1
EffectiveActivationDate	Effective date when the debtor has been activated.	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 RequestToPayDebtorActivationStatusReportV01 implementation follows a specific implementaiton pattern. First of all, RequestToPayDebtorActivationStatusReportV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestToPayDebtorActivationStatusReportV01Document implements IOuterDocument. Because RequestToPayDebtorActivationStatusReportV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestToPayDebtorActivationStatusReportV01.

classDiagram
    class IOuterRecord
    RequestToPayDebtorActivationStatusReportV01 --|> IOuterRecord : Implements
    RequestToPayDebtorActivationStatusReportV01Document --|> IOuterDocument~RequestToPayDebtorActivationStatusReportV01~ : Implements
    class IOuterDocument~RequestToPayDebtorActivationStatusReportV01~ {
        RequestToPayDebtorActivationStatusReportV01 Message
     }

Document wrapper for serialization

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

classDiagram
    RequestToPayDebtorActivationStatusReportV01Document *-- RequestToPayDebtorActivationStatusReportV01 : 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.073.001.01">
    <ReqToPayDbtrActvtnStsRpt>
        <Hdr>
            <!-- Header inner content -->
        </Hdr>
        <OrgnlActvtnAndSts>
            <!-- OriginalActivationAndStatus inner content -->
        </OrgnlActvtnAndSts>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </ReqToPayDbtrActvtnStsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_rNNB1-HzEeqbls7Gk4-ckA"
  name="RequestToPayDebtorActivationStatusReportV01"
  definition="The RequestToPayDebtorActivationStatusReport message is sent from the recipient of the debtor activation request message (initiation, amendment or cancellation), such as the creditor RTP provider or the creditor, to the initiator of the debtor activation request message (debtor, debtor RTP provider or any of the forwarding agent) to provide the status of the request. &#xD;&#xA;"
  registrationStatus="Registered"
  messageSet="_6PO9tOHwEeqbls7Gk4-ckA"
  xmlTag="ReqToPayDbtrActvtnStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_rNNB2eHzEeqbls7Gk4-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="_rNNB2-HzEeqbls7Gk4-ckA"
    name="Header"
    definition="Set of characteristics to identify the message and parties playing a role in the mandate acceptance, but which are not part of the mandate."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Hdr"
    complexType="_UUIee-H7Eeqbls7Gk4-ckA" />
  <messageBuildingBlock
    xmi:id="_rNNB3eHzEeqbls7Gk4-ckA"
    name="OriginalActivationAndStatus"
    definition="Status of the debtor activation instruction (that is request, amendment or cancellation)."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="OrgnlActvtnAndSts"
    complexType="_Ug_1x-H7Eeqbls7Gk4-ckA" />
  <messageBuildingBlock
    xmi:id="_rNNB3-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="073"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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