reda.070.001.01
The RequestToPayDebtorActivationRequest 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 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
%% RequestToPayDebtorActivationRequestV01 recursion level 0 with max 0
RequestToPayDebtorActivationRequestV01 *-- "1..1" ActivationHeader2 : Header
RequestToPayDebtorActivationRequestV01 *-- "1..1" DebtorActivation3 : DebtorActivation
RequestToPayDebtorActivationRequestV01 *-- "1..1" ElectronicInvoice1 : ElectronicInvoiceData
RequestToPayDebtorActivationRequestV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
Header building block
Header data for the creditor enrolment request. 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 |
DebtorActivation building block
Specific attributes provided the debtor, as requested by the creditor, for the activation request. Specifies the attributes for a debtor activation. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% DebtorActivation3 recursion level 0 with max 1
class DebtorActivation3{
DebtorActivationIdentification IsoMax35Text
DisplayName IsoMax140Text
DedicatedActivationCode IsoMax35Text
}
DebtorActivation3 *-- "0..1" RTPPartyIdentification1 : UltimateDebtor
DebtorActivation3 *-- "1..1" RTPPartyIdentification1 : Debtor
DebtorActivation3 *-- "1..1" RTPPartyIdentification1 : DebtorSolutionProvider
DebtorActivation3 *-- "0..0" IParty49Choice : CustomerIdentification
DebtorActivation3 *-- "0..0" IDocumentFormat2Choice : ContractFormatType
DebtorActivation3 *-- "0..0" ContractReference1 : ContractReference
DebtorActivation3 *-- "1..1" RTPPartyIdentification1 : Creditor
DebtorActivation3 *-- "0..1" RTPPartyIdentification1 : UltimateCreditor
DebtorActivation3 *-- "0..1" RTPPartyIdentification1 : ActivationRequestDeliveryParty
DebtorActivation3 *-- "0..1" IDateAndDateTime2Choice : StartDate
DebtorActivation3 *-- "0..1" IDateAndDateTime2Choice : EndDate
%% 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
%% IParty49Choice recursion level 1 with max 1
%% IDocumentFormat2Choice recursion level 1 with max 1
%% ContractReference1 recursion level 1 with max 1
class ContractReference1{
Reference IsoMax500Text
}
ContractReference1 *-- "0..1" IDocumentType1Choice : Type
%% 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
%% IDateAndDateTime2Choice recursion level 1 with max 1
%% IDateAndDateTime2Choice recursion level 1 with max 1
DebtorActivation3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| DebtorActivationIdentification | Unique identification, as assigned by the initiating party, to unambiguously identify the activation. Usage: This element may be used for technical reconciliation purpose. | IsoMax35Text - Optional 0..1 |
| DisplayName | Name by which the debtor is known, other than legal name, such as the name to be shown to the creditor. | IsoMax140Text - Optional 0..1 |
| UltimateDebtor | Ultimate party that owes an amount of money to the (ultimate) creditor. | RTPPartyIdentification1 - Optional 0..1 |
| Debtor | Party that owes an amount of money to the (ultimate) creditor. | RTPPartyIdentification1 - Required 1..1 |
| DebtorSolutionProvider | Organisation servicing the e-invoicing for the debtor (to which the activation status report must be sent). | RTPPartyIdentification1 - Required 1..1 |
| CustomerIdentification | Unique identifier of the debtor required by the creditor, for example the reference number or customer number. Unique identification provided by the web bank or web payment services user, with which the creditor may identify the debtor in its system. | IParty49Choice - Unknown 0..0 |
| ContractFormatType | Document format type supported to exchange the contracts. | IDocumentFormat2Choice - Unknown 0..0 |
| ContractReference | Code choice external/prop Description identical to the Instruction for Debtor | ContractReference1 - Unknown 0..0 |
| Creditor | Party to which an amount of money is due. | RTPPartyIdentification1 - Required 1..1 |
| UltimateCreditor | Ultimate party to which an amount of money is due. | RTPPartyIdentification1 - Optional 0..1 |
| ActivationRequestDeliveryParty | Creditor’s service provider address to which the debtor activation has to be delivered. | RTPPartyIdentification1 - Optional 0..1 |
| StartDate | Date and time at which the debtor activation will be activated. | IDateAndDateTime2Choice - Optional 0..1 |
| EndDate | Date and time at which the debtor activation will be deactivated. | IDateAndDateTime2Choice - Optional 0..1 |
| DedicatedActivationCode | Unique, one-time code that a creditor may require from a debtor for activation purposes, and which is known only by the creditor and the debtor. | IsoMax35Text - Optional 0..1 |
ElectronicInvoiceData building block
Further data related to the electronic invoice (e-invoice). Specifies details of the electronic invoice. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ElectronicInvoice1 recursion level 0 with max 1
class ElectronicInvoice1{
PresentmentType PresentmentType1Code
}
ElectronicInvoice1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PresentmentType | Type of elements to be presented in the electronic invoice (e-invoice). | PresentmentType1Code - Required 1..1 |
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 RequestToPayDebtorActivationRequestV01 implementation follows a specific implementaiton pattern. First of all, RequestToPayDebtorActivationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, RequestToPayDebtorActivationRequestV01Document implements IOuterDocument. Because RequestToPayDebtorActivationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type RequestToPayDebtorActivationRequestV01.
classDiagram
class IOuterRecord
RequestToPayDebtorActivationRequestV01 --|> IOuterRecord : Implements
RequestToPayDebtorActivationRequestV01Document --|> IOuterDocument~RequestToPayDebtorActivationRequestV01~ : Implements
class IOuterDocument~RequestToPayDebtorActivationRequestV01~ {
RequestToPayDebtorActivationRequestV01 Message
}
Document wrapper for serialization
The only real purpose RequestToPayDebtorActivationRequestV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.070.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using RequestToPayDebtorActivationRequestV01.ToDocument() method. The returned RequestToPayDebtorActivationRequestV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
RequestToPayDebtorActivationRequestV01Document *-- RequestToPayDebtorActivationRequestV01 : 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.070.001.01">
<ReqToPayDbtrActvtnReq>
<Hdr>
<!-- Header inner content -->
</Hdr>
<DbtrActvtn>
<!-- DebtorActivation inner content -->
</DbtrActvtn>
<ElctrncInvcData>
<!-- ElectronicInvoiceData inner content -->
</ElctrncInvcData>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</ReqToPayDbtrActvtnReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_rNNBzeHzEeqbls7Gk4-ckA"
name="RequestToPayDebtorActivationRequestV01"
definition="The RequestToPayDebtorActivationRequest 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 the debtor activation of the RTP service with that specific creditor."
registrationStatus="Registered"
messageSet="_6PO9tOHwEeqbls7Gk4-ckA"
xmlTag="ReqToPayDbtrActvtnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_rNNBz-HzEeqbls7Gk4-ckA"
name="Header"
definition="Header data for the creditor enrolment request."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Hdr"
complexType="_UUIee-H7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNB0eHzEeqbls7Gk4-ckA"
name="DebtorActivation"
definition="Specific attributes provided the debtor, as requested by the creditor, for the activation request."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="DbtrActvtn"
complexType="_UPBU9eH7Eeqbls7Gk4-ckA" />
<messageBuildingBlock
xmi:id="_rNNB0-HzEeqbls7Gk4-ckA"
name="ElectronicInvoiceData"
definition="Further data related to the electronic invoice (e-invoice)."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="ElctrncInvcData"
complexType="_7qk3ikWdEempSe_3C1a9EQ" />
<messageBuildingBlock
xmi:id="_rNNB1eHzEeqbls7Gk4-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="070"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.