pain.009.001.04
Scope The MandateInitiationRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor. The MandateInitiationRequest message is forwarded by the agent of the initiator to the agent of the counterparty. The MandateInitiationRequest message is used to setup the instruction that allows the debtor agent to accept instructions from the creditor, through the creditor agent, to debit the account of the debtor. Usage The MandateInitiationRequest message can contain one or more request(s) to setup a specific mandate. The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent. The message can also be used by an initiating party that has authority to send the message on behalf of the creditor or debtor. The MandateInitiationRequest message can be used in domestic and cross-border scenarios.
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 %% MandateInitiationRequestV04 recursion level 0 with max 0 MandateInitiationRequestV04 *-- "1..1" GroupHeader47 : GroupHeader MandateInitiationRequestV04 *-- "1..1" Mandate7 : Mandate MandateInitiationRequestV04 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
GroupHeader building block
Set of characteristics to identify the message and parties playing a role in the mandate initiation, but which are not part of the mandate. Set of characteristics shared by all individual transactions included in the message. For comparison, see the ISO20022 official specification
classDiagram direction tb %% GroupHeader47 recursion level 0 with max 1 class GroupHeader47{ MessageIdentification IsoMax35Text CreationDateTime IsoISODateTime } GroupHeader47 *-- "0..2" IAuthorisation1Choice : Authorisation GroupHeader47 *-- "0..1" PartyIdentification43 : InitiatingParty GroupHeader47 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructingAgent GroupHeader47 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : InstructedAgent %% IAuthorisation1Choice recursion level 1 with max 1 %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification
GroupHeader47 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MessageIdentification | Point to point reference, as assigned by the instructing party, and sent to the instructed party, 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. |
CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Required 1..1 |
Authorisation | User identification or any user key to be used to check the authority of the initiating party. | |
InitiatingParty | Party that initiates the mandate message. | PartyIdentification43 - Optional 0..1 |
InstructingAgent | Agent that instructs the next party in the chain to carry out an instruction. | |
InstructedAgent | Agent that is instructed by the previous party in the chain to carry out an instruction. |
Mandate building block
Set of elements used to provide the details of the mandate signed between the (ultimate) creditor and the (ultimate) debtor. Information that serves as a basis to debit an account. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Mandate7 recursion level 0 with max 1 class Mandate7{ MandateIdentification IsoMax35Text MandateRequestIdentification IsoMax35Text CollectionAmount IsoActiveCurrencyAndAmount MaximumAmount IsoActiveCurrencyAndAmount } Mandate7 *-- "0..1" MandateTypeInformation1 : Type Mandate7 *-- "0..1" MandateOccurrences3 : Occurrences Mandate7 *-- "0..1" IMandateSetupReason1Choice : Reason Mandate7 *-- "0..1" PartyIdentification43 : CreditorSchemeIdentification Mandate7 *-- "1..1" PartyIdentification43 : Creditor Mandate7 *-- "0..1" CashAccount24 : CreditorAccount Mandate7 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : CreditorAgent Mandate7 *-- "0..1" PartyIdentification43 : UltimateCreditor Mandate7 *-- "1..1" PartyIdentification43 : Debtor Mandate7 *-- "0..1" CashAccount24 : DebtorAccount Mandate7 *-- "1..1" BranchAndFinancialInstitutionIdentification5 : DebtorAgent Mandate7 *-- "0..1" PartyIdentification43 : UltimateDebtor Mandate7 *-- "0..0" ReferredDocumentInformation6 : ReferredDocument Mandate7 *-- "0..0" SupplementaryData1 : SupplementaryData %% MandateTypeInformation1 recursion level 1 with max 1 MandateTypeInformation1 *-- "0..1" IServiceLevel8Choice : ServiceLevel MandateTypeInformation1 *-- "0..1" ILocalInstrument2Choice : LocalInstrument %% MandateOccurrences3 recursion level 1 with max 1 class MandateOccurrences3{ SequenceType SequenceType2Code FirstCollectionDate IsoISODate FinalCollectionDate IsoISODate } MandateOccurrences3 *-- "0..1" IFrequency21Choice : Frequency MandateOccurrences3 *-- "0..1" DatePeriodDetails1 : Duration %% IMandateSetupReason1Choice recursion level 1 with max 1 %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% CashAccount24 recursion level 1 with max 1 class CashAccount24{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount24 *-- "0..1" ICashAccountType2Choice : Type %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% CashAccount24 recursion level 1 with max 1 class CashAccount24{ Currency ActiveOrHistoricCurrencyCode Name IsoMax70Text } CashAccount24 *-- "1..1" IAccountIdentification4Choice : Identification CashAccount24 *-- "0..1" ICashAccountType2Choice : Type %% BranchAndFinancialInstitutionIdentification5 recursion level 1 with max 1 BranchAndFinancialInstitutionIdentification5 *-- "1..1" FinancialInstitutionIdentification8 : FinancialInstitutionIdentification BranchAndFinancialInstitutionIdentification5 *-- "0..1" BranchData2 : BranchIdentification %% PartyIdentification43 recursion level 1 with max 1 class PartyIdentification43{ Name IsoMax140Text CountryOfResidence CountryCode } PartyIdentification43 *-- "0..1" PostalAddress6 : PostalAddress PartyIdentification43 *-- "0..1" IParty11Choice : Identification PartyIdentification43 *-- "0..1" ContactDetails2 : ContactDetails %% ReferredDocumentInformation6 recursion level 1 with max 1 class ReferredDocumentInformation6{ Number IsoMax35Text RelatedDate IsoISODate } ReferredDocumentInformation6 *-- "0..1" ReferredDocumentType4 : Type %% SupplementaryData1 recursion level 1 with max 1 class SupplementaryData1{ PlaceAndName IsoMax350Text } SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
Mandate7 members
Member name | Description | Data Type / Multiplicity |
---|---|---|
MandateIdentification | Unique identification, as assigned by the creditor, to unambiguously identify the mandate. | IsoMax35Text - Unknown 0..0 |
MandateRequestIdentification | Identification for the mandate request, as assigned by the initiating party. | IsoMax35Text - Required 1..1 |
Type | Specifies the type of mandate, such as paper, electronic or scheme. | MandateTypeInformation1 - Optional 0..1 |
Occurrences | Provides details of the duration of the mandate and occurrence of the underlying transactions. | MandateOccurrences3 - Optional 0..1 |
CollectionAmount | Fixed amount to be collected from the debtor’s account. | IsoActiveCurrencyAndAmount - Optional 0..1 |
MaximumAmount | Maximum amount that may be collected from the debtor’s account, per instruction. | IsoActiveCurrencyAndAmount - Optional 0..1 |
Reason | Provides the reason for the setup of the mandate. | IMandateSetupReason1Choice - Optional 0..1 |
CreditorSchemeIdentification | Credit party that signs the mandate. | PartyIdentification43 - Optional 0..1 |
Creditor | Party that signs the mandate and to whom an amount of money is due. | PartyIdentification43 - Required 1..1 |
CreditorAccount | Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. | CashAccount24 - Optional 0..1 |
CreditorAgent | Financial institution servicing an account for the creditor. | BranchAndFinancialInstitutionIdentification5 - Optional 0..1 |
UltimateCreditor | Ultimate party to which an amount of money is due. | PartyIdentification43 - Optional 0..1 |
Debtor | Party that signs the mandate and owes an amount of money to the (ultimate) creditor. | PartyIdentification43 - Required 1..1 |
DebtorAccount | Unambiguous identification of the account of the debtor, to which a debit entry will be made as a result of the transaction. | CashAccount24 - Optional 0..1 |
DebtorAgent | Financial institution servicing an account for the debtor. | BranchAndFinancialInstitutionIdentification5 - Required 1..1 |
UltimateDebtor | Ultimate party that owes an amount of money to the (ultimate) creditor. | PartyIdentification43 - Optional 0..1 |
ReferredDocument | Provides information to identify the underlying documents associated with the mandate. | ReferredDocumentInformation6 - Unknown 0..0 |
SupplementaryData | Additional information that cannot be captured in the structured elements within the message component. | 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 MandateInitiationRequestV04 implementation follows a specific implementaiton pattern. First of all, MandateInitiationRequestV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MandateInitiationRequestV04Document implements IOuterDocument. Because MandateInitiationRequestV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MandateInitiationRequestV04.
classDiagram class IOuterRecord MandateInitiationRequestV04 --|> IOuterRecord : Implements MandateInitiationRequestV04Document --|> IOuterDocument~MandateInitiationRequestV04~ : Implements class IOuterDocument~MandateInitiationRequestV04~ { MandateInitiationRequestV04 Message }
Document wrapper for serialization
The only real purpose MandateInitiationRequestV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:pain.009.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MandateInitiationRequestV04.ToDocument() method. The returned MandateInitiationRequestV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram MandateInitiationRequestV04Document *-- MandateInitiationRequestV04 : 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:pain.009.001.04">
<MndtInitnReq>
<GrpHdr>
<!-- GroupHeader inner content -->
</GrpHdr>
<Mndt>
<!-- Mandate inner content -->
</Mndt>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</MndtInitnReq>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_Ie2IXxPeEeSVo-TFVwFHvA"
nextVersions="_ecUrgUjuEeaVLL5QKJ4f-A"
previousVersion="_i2t34SGmEeKjd4jizyIDGA"
name="MandateInitiationRequestV04"
definition="Scope
The MandateInitiationRequest message is sent by the initiator of the request to his agent. The initiator can either be the debtor or the creditor.
The MandateInitiationRequest message is forwarded by the agent of the initiator to the agent of the counterparty.
The MandateInitiationRequest message is used to setup the instruction that allows the debtor agent to accept instructions from the creditor, through the creditor agent, to debit the account of the debtor.
Usage
The MandateInitiationRequest message can contain one or more request(s) to setup a specific mandate.
The messages can be exchanged between creditor and creditor agent or debtor and debtor agent and between creditor agent and debtor agent.
The message can also be used by an initiating party that has authority to send the message on behalf of the creditor or debtor.
The MandateInitiationRequest message can be used in domestic and cross-border scenarios."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="MndtInitnReq"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<constraint
xmi:id="_Ie2IYRPeEeSVo-TFVwFHvA"
nextVersions="_ecUrg0juEeaVLL5QKJ4f-A"
previousVersion="_1oxZ0SmeEeKdFJmzhTDOvQ"
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="_Ie2IYxPeEeSVo-TFVwFHvA"
nextVersions="_ecUrhUjuEeaVLL5QKJ4f-A"
previousVersion="_i2t34yGmEeKjd4jizyIDGA"
name="GroupHeader"
definition="Set of characteristics to identify the message and parties playing a role in the mandate initiation, but which are not part of the mandate."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="GrpHdr"
complexType="_s3oCIFkyEeGeoaLUQk__nA_-839305610" />
<messageBuildingBlock
xmi:id="_Ie2IZRPeEeSVo-TFVwFHvA"
nextVersions="_ecUrh0juEeaVLL5QKJ4f-A"
previousVersion="_i2t35yGmEeKjd4jizyIDGA"
name="Mandate"
definition="Set of elements used to provide the details of the mandate signed between the (ultimate) creditor and the (ultimate) debtor."
registrationStatus="Provisionally Registered"
minOccurs="1"
xmlTag="Mndt"
complexType="_aLTuRx77EeSxevWRRWxNAg" />
<messageBuildingBlock
xmi:id="_Ie2IZxPeEeSVo-TFVwFHvA"
nextVersions="_ecUriUjuEeaVLL5QKJ4f-A"
previousVersion="_i2t36yGmEeKjd4jizyIDGA"
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="pain"
messageFunctionality="009"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.