UndertakingAmendmentRequestV01

tsrv.004.001.01

The UndertakingAmendmentRequest message is sent by the party that requested issuance of the undertaking (applicant or obligor) to the party that issued the undertaking to request issuance of a proposed amendment to the undertaking. The undertaking could be a demand guarantee, standby letter of credit, counter-undertaking (counter-guarantee or counter-standby), or suretyship undertaking. The message provides details on proposed changes to the undertaking, for example, to the expiry date, amount, and/or terms and conditions. It may also be used to request termination or cancellation of the undertaking.

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
%% UndertakingAmendmentRequestV01 recursion level 0 with max 0
class UndertakingAmendmentRequestV01{
    InstructionsToBank IsoMax2000Text
}
UndertakingAmendmentRequestV01 *-- "1..1" Amendment3 : UndertakingAmendmentRequestDetails
UndertakingAmendmentRequestV01 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

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

UndertakingAmendmentRequestDetails building block

Details related to the request for an amendment of an undertaking. Details of the amendent request. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Amendment3 recursion level 0 with max 1
class Amendment3{
    ApplicantRequestNumber IsoMax35Text
    AdditionalInformation IsoMax2000Text
}
Amendment3 *-- "1..1" Undertaking9 : UndertakingIdentification
Amendment3 *-- "1..1" PartyIdentification43 : Applicant
Amendment3 *-- "0..1" UndertakingTermination3 : TerminationDetails
Amendment3 *-- "0..1" UndertakingAmount2 : IncreaseDecreaseAmount
Amendment3 *-- "0..1" ExpiryDetails2 : NewExpiryDetails
Amendment3 *-- "0..1" Beneficiary1 : NewBeneficiary
Amendment3 *-- "0..0" Narrative1 : NewUndertakingTermsAndConditions
Amendment3 *-- "0..1" Undertaking10 : CounterUndertaking
Amendment3 *-- "0..1" CommunicationChannel1 : DeliveryChannel
Amendment3 *-- "0..0" Document9 : EnclosedFile
%% Undertaking9 recursion level 1 with max 1
class Undertaking9{
    Identification IsoMax35Text
    ApplicantReferenceNumber IsoMax35Text
}
Undertaking9 *-- "1..1" PartyIdentification43 : Issuer
%% 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
%% UndertakingTermination3 recursion level 1 with max 1
class UndertakingTermination3{
    EffectiveDate IsoISODate
    AdditionalInformation IsoMax2000Text
}
UndertakingTermination3 *-- "0..1" ITerminationReason1Choice : Reason
%% UndertakingAmount2 recursion level 1 with max 1
class UndertakingAmount2{
    AdditionalInformation IsoMax2000Text
}
UndertakingAmount2 *-- "1..1" IAmount1Choice : AmountChoice
%% ExpiryDetails2 recursion level 1 with max 1
class ExpiryDetails2{
    AdditionalExpiryInformation IsoMax2000Text
}
ExpiryDetails2 *-- "0..1" ExpiryTerms2 : ExpiryTerms
%% Beneficiary1 recursion level 1 with max 1
class Beneficiary1{
    AdditionalInformation IsoMax2000Text
}
Beneficiary1 *-- "1..1" IAddressOrParty1Choice : NewAddressOrNewBeneficiary
%% Narrative1 recursion level 1 with max 1
class Narrative1{
    Text IsoMax20000Text
}
Narrative1 *-- "0..1" INarrativeType1Choice : Type
%% Undertaking10 recursion level 1 with max 1
Undertaking10 *-- "0..1" UndertakingAmount2 : NewUndertakingAmount
Undertaking10 *-- "0..1" ExpiryDetails1 : NewExpiryDetails
%% CommunicationChannel1 recursion level 1 with max 1
class CommunicationChannel1{
    Method ExternalChannel1Code
    DeliverToName IsoMax140Text
}
CommunicationChannel1 *-- "1..1" IPartyType1Choice : DeliverToPartyType
CommunicationChannel1 *-- "0..1" PostalAddress6 : DeliverToAddress
%% Document9 recursion level 1 with max 1
class Document9{
    Identification IsoMax35Text
    Enclosure IsoMax2MBBinary
}
Document9 *-- "1..1" IUndertakingDocumentType1Choice : Type
Document9 *-- "0..1" IDocumentFormat1Choice : Format
Document9 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

Amendment3 members

InstructionsToBank building block

Instructions specific to the bank receiving the message. 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 undertaking amendment request. 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 UndertakingAmendmentRequestV01 implementation follows a specific implementaiton pattern. First of all, UndertakingAmendmentRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, UndertakingAmendmentRequestV01Document implements IOuterDocument. Because UndertakingAmendmentRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type UndertakingAmendmentRequestV01.

classDiagram
    class IOuterRecord
    UndertakingAmendmentRequestV01 --|> IOuterRecord : Implements
    UndertakingAmendmentRequestV01Document --|> IOuterDocument~UndertakingAmendmentRequestV01~ : Implements
    class IOuterDocument~UndertakingAmendmentRequestV01~ {
        UndertakingAmendmentRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    UndertakingAmendmentRequestV01Document *-- UndertakingAmendmentRequestV01 : 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.004.001.01">
    <UdrtkgAmdmntReq>
        <UdrtkgAmdmntReqDtls>
            <!-- UndertakingAmendmentRequestDetails inner content -->
        </UdrtkgAmdmntReqDtls>
        <InstrsToBk>
            <!-- InstructionsToBank inner content -->
        </InstrsToBk>
        <DgtlSgntr>
            <!-- DigitalSignature inner content -->
        </DgtlSgntr>
    </UdrtkgAmdmntReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_9f3CdnltEeG7BsjMvd1mEw_-206674723"
  name="UndertakingAmendmentRequestV01"
  definition="The UndertakingAmendmentRequest message is sent by the party that requested issuance of the undertaking (applicant or obligor) to the party that issued the undertaking to request issuance of a proposed amendment to the undertaking. The undertaking could be a demand guarantee, standby letter of credit, counter-undertaking (counter-guarantee or counter-standby), or suretyship undertaking. The message provides details on proposed changes to the undertaking, for example, to the expiry date, amount, and/or terms and conditions. It may also be used to request termination or cancellation of the undertaking."
  registrationStatus="Registered"
  messageSet="_SiMuI9n1EeGEPsbnW6ebrw"
  xmlTag="UdrtkgAmdmntReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_9f3Cd3ltEeG7BsjMvd1mEw_-1387733041"
    name="UndertakingAmendmentRequestDetails"
    definition="Details related to the request for an amendment of an undertaking."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="UdrtkgAmdmntReqDtls"
    complexType="_999TsHltEeG7BsjMvd1mEw_-1184372634" />
  <messageBuildingBlock
    xmi:id="_MZwWVX_6EeGOn4dfTT_QdQ"
    name="InstructionsToBank"
    definition="Instructions specific to the bank receiving the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="5"
    minOccurs="0"
    xmlTag="InstrsToBk"
    simpleType="_YYn11dp-Ed-ak6NoX_4Aeg_2132907481" />
  <messageBuildingBlock
    xmi:id="_9f3CeHltEeG7BsjMvd1mEw_-2129123977"
    name="DigitalSignature"
    definition="Digital signature of the undertaking amendment request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="DgtlSgntr"
    complexType="_k4nFNZKuEeGnRMFvqYmPBQ" />
  <messageDefinitionIdentifier
    businessArea="tsrv"
    messageFunctionality="004"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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