ExtendOrPayRequestV01

tsrv.014.001.01

The ExtendOrPayRequest message is sent by the party that issued the undertaking to the party that requested issuance of the undertaking (applicant or obligor), to request the applicant’s response to a beneficiary request to extend or pay.

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
%% ExtendOrPayRequestV01 recursion level 0 with max 0
ExtendOrPayRequestV01 *-- "1..1" ExtendOrPayQuery1 : ExtendOrPayRequestDetails
ExtendOrPayRequestV01 *-- "0..1" PartyAndSignature2 : DigitalSignature
  

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

ExtendOrPayRequestDetails building block

Details of the extend or pay request. Undertaking extend or pay query details. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ExtendOrPayQuery1 recursion level 0 with max 1
class ExtendOrPayQuery1{
    RequestedExpiryDate IsoISODate
    AdditionalInformation IsoMax2000Text
}
ExtendOrPayQuery1 *-- "1..1" Undertaking9 : UndertakingIdentification
ExtendOrPayQuery1 *-- "1..1" Demand2 : DemandDetails
ExtendOrPayQuery1 *-- "0..1" BankInstructions1 : BankInstructions
ExtendOrPayQuery1 *-- "0..0" Contacts3 : BankContact
ExtendOrPayQuery1 *-- "0..0" Document9 : EnclosedFile
%% Undertaking9 recursion level 1 with max 1
class Undertaking9{
    Identification IsoMax35Text
    ApplicantReferenceNumber IsoMax35Text
}
Undertaking9 *-- "1..1" PartyIdentification43 : Issuer
%% Demand2 recursion level 1 with max 1
class Demand2{
    Identification IsoMax35Text
    SubmissionDateTime IsoISODateTime
    Amount IsoActiveCurrencyAndAmount
    AdditionalInformation IsoMax2000Text
}
%% BankInstructions1 recursion level 1 with max 1
class BankInstructions1{
    Text IsoMax2000Text
    LastDateForResponse IsoISODate
}
%% Contacts3 recursion level 1 with max 1
class Contacts3{
    NamePrefix NamePrefix1Code
    Name IsoMax140Text
    PhoneNumber IsoPhoneNumber
    MobileNumber IsoPhoneNumber
    FaxNumber IsoPhoneNumber
    EmailAddress IsoMax2048Text
    Other IsoMax35Text
    JobTitle IsoMax35Text
    Responsibility IsoMax35Text
    Department IsoMax70Text
}
%% 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
  

ExtendOrPayQuery1 members

DigitalSignature building block

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

classDiagram
    class IOuterRecord
    ExtendOrPayRequestV01 --|> IOuterRecord : Implements
    ExtendOrPayRequestV01Document --|> IOuterDocument~ExtendOrPayRequestV01~ : Implements
    class IOuterDocument~ExtendOrPayRequestV01~ {
        ExtendOrPayRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    ExtendOrPayRequestV01Document *-- ExtendOrPayRequestV01 : 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.014.001.01">
    <XtndOrPayReq>
        <XtndOrPayReqDtls>
            <!-- ExtendOrPayRequestDetails inner content -->
        </XtndOrPayReqDtls>
        <DgtlSgntr>
            <!-- DigitalSignature inner content -->
        </DgtlSgntr>
    </XtndOrPayReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_9hNGQnltEeG7BsjMvd1mEw_-1297539311"
  name="ExtendOrPayRequestV01"
  definition="The ExtendOrPayRequest message is sent by the party that issued the undertaking to the party that requested issuance of the undertaking (applicant or obligor), to request the applicant's response to a beneficiary request to extend or pay."
  registrationStatus="Registered"
  messageSet="_SiMuI9n1EeGEPsbnW6ebrw"
  xmlTag="XtndOrPayReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_9hNGQ3ltEeG7BsjMvd1mEw_-740598928"
    name="ExtendOrPayRequestDetails"
    definition="Details of the extend or pay request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="XtndOrPayReqDtls"
    complexType="_-Des53ltEeG7BsjMvd1mEw_2002292702" />
  <messageBuildingBlock
    xmi:id="_9hNGRHltEeG7BsjMvd1mEw_1034955414"
    name="DigitalSignature"
    definition="Digital signature of the request."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="DgtlSgntr"
    complexType="_k4nFNZKuEeGnRMFvqYmPBQ" />
  <messageDefinitionIdentifier
    businessArea="tsrv"
    messageFunctionality="014"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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