XML Schema Documentation

Element: mortgage

[Table of contents]

  • This element can be used wherever the following element is referenced:
Name mortgage
Type Mortgage
Nillable no
Abstract no
Documentation Defines an underlying asset that is a mortgage.
Logical Diagram
XML Instance Representation
<mortgage
id=" xsd:ID [0..1]">
<instrumentId> InstrumentId </instrumentId> [1..*]

'Identification of the underlying asset, using public and/or private identifiers.'

<description> xsd:string </description> [0..1]

'Long name of the underlying asset.'

<currency> Currency </currency> [0..1]

'Currency in which the underlying asset is denominated.'

<exchangeId> ExchangeId </exchangeId> [0..1]

'Identification of the exchange on which this asset is transacted for the purposes of calculating a contractural payoff. The term \"Exchange\" is assumed to have the meaning as defined in the ISDA 2002 Equity Derivatives Definitions.'

<clearanceSystem> ClearanceSystem </clearanceSystem> [0..1]

'Identification of the clearance system associated with the transaction exchange.'

<definition> ProductReference </definition> [0..1]

'An optional reference to a full FpML product that defines the simple product in greater detail. In case of inconsistency between the terms of the simple product and those of the detailed definition, the values in the simple product override those in the detailed definition.'

Start Choice [0..1]

'Applicable to the case of default swaps on MBS terms. For specifying the insurer name, when applicable (when the element is not present, it signifies that the insurer is Not Applicable)'


<insurer> LegalEntity </insurer> [1]
<insurerReference> LegalEntityReference </insurerReference> [1]
End Choice
Start Choice [0..1]

'Specifies the issuer name of a fixed income security or convertible bond. This name can either be explicitly stated, or specified as an href into another element of the document, such as the obligor'


<issuerName> xsd:string </issuerName> [1]
<issuerPartyReference> PartyReference </issuerPartyReference> [1]
End Choice
<seniority> CreditSeniority </seniority> [0..1]

'The repayment precedence of a debt instrument.'

<couponType> CouponType </couponType> [0..1]

'Specifies if the bond has a variable coupon, step-up/down coupon or a zero-coupon.'

<couponRate> xsd:decimal </couponRate> [0..1]

'Specifies the coupon rate (expressed in percentage) of a fixed income security or convertible bond.'

<maturity> xsd:date </maturity> [0..1]

'The date when the principal amount of a security becomes due and payable.'

<paymentFrequency> Interval </paymentFrequency> [0..1]

'Specifies the frequency at which the bond pays, e.g. 6M.'

<dayCountFraction> DayCountFraction </dayCountFraction> [0..1]

'The day count basis for the bond.'

<originalPrincipalAmount> xsd:decimal </originalPrincipalAmount> [0..1]

'The initial issued amount of the mortgage obligation.'

<pool> AssetPool </pool> [0..1]

'The morgage pool that is underneath the mortgage obligation.'

<sector> MortgageSector </sector> [0..1]

'The sector classification of the mortgage obligation.'

<tranche> xsd:token </tranche> [0..1]

'The mortgage obligation tranche that is subject to the derivative transaction.'

</mortgage>
Diagram
element_basket element_bond element_cash element_convertibleBond element_deposit element_equity element_exchangeTradedFund element_future element_fxRate element_index element_loan element_mutualFund element_rateIndex element_simpleCreditDefaultSwap element_simpleFra element_simpleIrSwap
Schema Component Representation
<xsd:element name="mortgage" type=" Mortgage " substitutionGroup="underlyingAsset"/>