UndertakingDemandV01

tsrv.013.001.01

The UndertakingDemand message and other required documents are sent by the beneficiary to the party that issued the undertaking, either directly or via a presenting or nominated party. It is a demand for payment and may include a request to extend the undertaking expiry date. The demand itself must be contained in an enclosed file within the message or must be specified as narrative text within the message. It may contain other required documents in addition to the demand.

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
%% UndertakingDemandV01 recursion level 0 with max 0
class UndertakingDemandV01{
    BankToBankInformation IsoMax2000Text
}
UndertakingDemandV01 *-- "1..1" Demand1 : UndertakingDemandDetails
UndertakingDemandV01 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

Now, we will zero-in one-by-one on each of these building blocks.

UndertakingDemandDetails building block

Details of the demand. Details of the demand. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Demand1 recursion level 0 with max 1
class Demand1{
    Identification IsoMax35Text
    Type DemandType1Code
    AdvisingPartyReferenceNumber IsoMax35Text
    SecondAdvisingPartyReferenceNumber IsoMax35Text
    ConfirmerReferenceNumber IsoMax35Text
    RequestedExpiryDate IsoISODate
    AdditionalInformation IsoMax2000Text
}
Demand1 *-- "1..1" Undertaking6 : UndertakingIdentification
Demand1 *-- "1..1" UndertakingAmount3 : DemandAmount
Demand1 *-- "0..0" CashAccount27 : SettlementAccount
Demand1 *-- "0..1" Presentation2 : PresentationDetails
Demand1 *-- "0..1" DemandDocumentation1 : DemandDocumentation
%% Undertaking6 recursion level 1 with max 1
class Undertaking6{
    Identification IsoMax35Text
    BeneficiaryReferenceNumber IsoMax35Text
}
Undertaking6 *-- "1..1" PartyIdentification43 : Issuer
%% UndertakingAmount3 recursion level 1 with max 1
class UndertakingAmount3{
    Amount IsoActiveCurrencyAndAmount
    AdditionalInformation IsoMax2000Text
}
%% CashAccount27 recursion level 1 with max 1
class CashAccount27{
    Currency ActiveOrHistoricCurrencyCode
    Name IsoMax70Text
}
CashAccount27 *-- "1..1" IAccountIdentification4Choice : Identification
CashAccount27 *-- "0..1" CashAccountType2 : Type
CashAccount27 *-- "0..1" PartyIdentification41 : Owner
CashAccount27 *-- "0..1" BranchAndFinancialInstitutionIdentification5 : Servicer
%% Presentation2 recursion level 1 with max 1
class Presentation2{
    BeneficiaryPresentationDate IsoISODate
}
Presentation2 *-- "0..1" PartyIdentification43 : Presenter
%% DemandDocumentation1 recursion level 1 with max 1
class DemandDocumentation1{
    CompleteIndicator IsoYesNoIndicator
    CompletionInformation IsoMax2000Text
    DemandNarrative IsoMax20000Text
}
DemandDocumentation1 *-- "0..0" Document9 : EnclosedFile
  

Demand1 members

BankToBankInformation building block

Additional information specific to the bank-to-bank communication. Specifies a character string with a maximum length of 2000 characters. For comparison, see the ISO20022 official specification This message is declared as Max2000Text in the ISO specification. In our implementation, it is represented in source code as IsoMax2000Text. Due to global using directives, it is treated as a System.String by the compiler and runtime.

DigitalSignature building block

Digital signature of the demand. Entity involved in an activity. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyAndSignature2 recursion level 0 with max 1
PartyAndSignature2 *-- "1..1" PartyIdentification43 : Party
PartyAndSignature2 *-- "1..1" ProprietaryData3 : Signature
%% 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
%% ProprietaryData3 recursion level 1 with max 1
ProprietaryData3 *-- "1..1" SkipProcessing : Any
  

PartyAndSignature2 members

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the UndertakingDemandV01 implementation follows a specific implementaiton pattern. First of all, UndertakingDemandV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, UndertakingDemandV01Document implements IOuterDocument. Because UndertakingDemandV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type UndertakingDemandV01.

classDiagram
    class IOuterRecord
    UndertakingDemandV01 --|> IOuterRecord : Implements
    UndertakingDemandV01Document --|> IOuterDocument~UndertakingDemandV01~ : Implements
    class IOuterDocument~UndertakingDemandV01~ {
        UndertakingDemandV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    UndertakingDemandV01Document *-- UndertakingDemandV01 : 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:tsrv.013.001.01">
    <UdrtkgDmnd>
        <UdrtkgDmndDtls>
            <!-- UndertakingDemandDetails inner content -->
        </UdrtkgDmndDtls>
        <BkToBkInf>
            <!-- BankToBankInformation inner content -->
        </BkToBkInf>
        <DgtlSgntr>
            <!-- DigitalSignature inner content -->
        </DgtlSgntr>
    </UdrtkgDmnd>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_9hDVQnltEeG7BsjMvd1mEw_2036606327"
  name="UndertakingDemandV01"
  definition="The UndertakingDemand message and other required documents are sent by the beneficiary to the party that issued the undertaking, either directly or via a presenting or nominated party. It is a demand for payment and may include a request to extend the undertaking expiry date. The demand itself must be contained in an enclosed file within the message or must be specified as narrative text within the message. It may contain other required documents in addition to the demand."
  registrationStatus="Registered"
  messageSet="_SiMuI9n1EeGEPsbnW6ebrw"
  xmlTag="UdrtkgDmnd"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_9hDVQ3ltEeG7BsjMvd1mEw_-612873100"
    name="UndertakingDemandDetails"
    definition="Details of the demand."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="UdrtkgDmndDtls"
    complexType="_-AylQnltEeG7BsjMvd1mEw_1908468693" />
  <messageBuildingBlock
    xmi:id="_AIs9UBVIEeKVqNjC36CBuQ"
    name="BankToBankInformation"
    definition="Additional information specific to the bank-to-bank communication."
    registrationStatus="Provisionally Registered"
    maxOccurs="5"
    minOccurs="0"
    xmlTag="BkToBkInf"
    simpleType="_YYn11dp-Ed-ak6NoX_4Aeg_2132907481" />
  <messageBuildingBlock
    xmi:id="_9hDVRHltEeG7BsjMvd1mEw_-415271236"
    name="DigitalSignature"
    definition="Digital signature of the demand."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="DgtlSgntr"
    complexType="_k4nFNZKuEeGnRMFvqYmPBQ" />
  <messageDefinitionIdentifier
    businessArea="tsrv"
    messageFunctionality="013"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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