|
IHS Markit API |
POST v1/ABS
Description
Add a new ABS asset.
Base Url
https://services.wsoweb.com/
Rest Call Syntax
POST SecurityMaster/v1/ABS
POST SecurityMaster/v1/ABS
Name
Description
Type
Additional Information
AssetBackedSecurityName
The name of the asset in WSO which typically includes the coupon rate and maturity date
string
Required
FirstCouponDate
The first coupon payment date for the ABS asset
date
Required
InterestAccrualDate
The first date that the asset starts accruing interest
date
Required
IssuerId
The issuer of the ABS asset by ID
integer
Required
MaturityDate
The maturity date of the ABS asset
date
Required
AssetClassId
The class of the ABS asset set by the user
integer
Collateral
The description of the collateral that is backing the asset
string
CountryId
The legal country for this ABS asset by ID value
integer
CouponDateOffset
Business Day Offset - this determines when a coupon should pay if the coupon date falls on a non-business day
CouponFrequency
This is a number corresponding to how many times a year there is a coupon payment
CurrencyCode
The currency type for this ABS
string
DataFeedId
The Id of the external data importing source for this asset
integer
DateOffset
Given the type of coupon - this is the number of days to offset the coupon rate
integer
DefaultDate
The date that the ABS asset went into default status
date
DefaultType
The type of default that has occurred on the ABS asset
string
FirstSettleDate
The first settle date listed for the ABS asset
date
FixedRate
The fixed coupon rate
decimal number
GuarantorId
The guarantor for this asset by ID value
integer
HasAttachedWarrants
The flag indicating if the asset has attached warrants
boolean
HasDefaulted
The flag indicating if the asset has defaulted
boolean
HasFXRisk
The flag indicating if the asset has foreign exchange risk
boolean
HolidayCalendarId
The holiday calendar for the ABS asset by ID value
integer
InsurerId
The Id for the insurer of the asset by ID value
integer
IsBaseRateObservationShiftEnabled
The flag indicating if the Bond asset has Observation Shift on RFR rate option
boolean
IsEmergingMarket
The flag indicating if the asset is from an emerging market
boolean
IsInterestOnly
The flag indicating if this is an interest only ABS asset
boolean
IsMostSeniorTranche
The flag indicating if the ABS asset is the most senior tranche
boolean
IsPrincipalOnly
The flag indicating if this is a principal only asset
boolean
IsPrivate
The flag indicating if this is a private security
boolean
IsRestructured
The flag indicating if the security has been restructured since it was initially issued
boolean
IsStructuredFinanceObligation
The flag indicating if the ABS asset belongs to a structured finance obligation.
boolean
Issue
The issue description of the ABS asset
string
IssueDate
The date that the asset was officially issued
date
IssuePrice
The original price at which the ABS asset was issued
decimal number
IssueSize
The original global amount of the ABS asset at issuance
decimal number
IsSynthetic
The flag indicating if this a synthetic security
boolean
IsTradedAccrued
The flag indicating if the ABS asset trades with accrued interest
boolean
LeadUnderwriterId
The lead underwriting bank of the ABS asset by ID value
integer
LockoutDays
Gets or sets the lockout days from 0 (zero) to 30 for the ABS asset.
integer
MaturityDateExpected
The expected maturity date of the ABS asset - optional field
date
Notes
The notes regarding the ABS asset
string
OriginalCapPercentage
The original capitalized percentage of the ABS asset
decimal number
PayNonBusinessDirection
Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay
PayOffsetDays
Pay Offset - the number of days that coupon payment occurs differing from the coupon date
integer
PaysEndOfMonth
The flag indicating if this asset pays end of month when the first coupon date does not fall on the 31st
boolean
RateOptionId
The rate option for the ABS asset
integer
RegistrationType
The registration type
string
SeniorityId
The seniority level of the ABS asset by ID value
integer
SpreadRate
The spread rate of the ABS asset
decimal number
TransferAgentId
The agent responsible for issuing certificates by ID value
integer
Limitations
-
ABS can be Interest only or Principal only, but not both
-
Coupon Type: Fixed – rate required
-
Coupon Type: Fixed Step Up – cannot add a fixed rate, rate option, offset, or coupon date offset
-
Coupon Type: Float Step Up – cannot add a spread
-
Coupon Type: Variable – cannot add a rate, rate option type, or offset
-
Coupon Type: Zero Coupon – cannot add a rate, rate option, coupon date offset, or pay offset
Request Information
Request body formats
application/json, text/json
{
"assetBackedSecurityName": "sample string 1",
"assetClassId": 1,
"collateral": "sample string 2",
"countryId": 1,
"couponDateOffset": "None",
"couponFrequency": "Annual",
"couponType": "Fixed",
"currencyCode": "sample string 3",
"dataFeedId": 1,
"dateOffset": 1,
"dayCount": "ACT_ACT",
"defaultDate": "2024-11-23T01:50:38.4967251-06:00",
"defaultType": "sample string 4",
"firstCouponDate": "2024-11-23T01:50:38.4967251-06:00",
"firstSettleDate": "2024-11-23T01:50:38.4967251-06:00",
"fixedRate": 1.1,
"guarantorId": 1,
"hasAttachedWarrants": true,
"hasFXRisk": true,
"holidayCalendarId": 1,
"insurerId": 1,
"interestAccrualDate": "2024-11-23T01:50:38.4977254-06:00",
"hasDefaulted": true,
"isEmergingMarket": true,
"isInterestOnly": true,
"isMostSeniorTranche": true,
"isPrincipalOnly": true,
"isBaseRateObservationShiftEnabled": true,
"isPrivate": true,
"isRestructured": true,
"isStructuredFinanceObligation": true,
"issue": "sample string 18",
"issueDate": "2024-11-23T01:50:38.4977254-06:00",
"issuePrice": 1.1,
"issuerId": 19,
"issueSize": 1.0,
"isSynthetic": true,
"isTradedAccrued": true,
"leadUnderwriterId": 1,
"lockoutDays": 22,
"maturityDate": "2024-11-23T01:50:38.4987252-06:00",
"maturityDateExpected": "2024-11-23T01:50:38.4987252-06:00",
"notes": "sample string 25",
"originalCapPercentage": 26.1,
"payNonBusinessDirection": "On",
"payOffsetDays": 27,
"payOffsetDirection": "After",
"payOffsetType": "BusinessDays",
"paysEndOfMonth": true,
"rateOptionId": 1,
"registrationType": "sample string 29",
"seniorityId": 1,
"spreadRate": 1.1,
"transferAgentId": 1,
"baseRateCompoundMethod": "Unassigned",
"baseRateInterestMethod": "Unassigned"
}
application/xml, text/xml
<AbsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AssetBackedSecurityName>sample string 1</AssetBackedSecurityName> <AssetClassId>1</AssetClassId> <BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod> <BaseRateInterestMethod>Unassigned</BaseRateInterestMethod> <Collateral>sample string 2</Collateral> <CountryId>1</CountryId> <CouponDateOffset>None</CouponDateOffset> <CouponFrequency>Annual</CouponFrequency> <CouponType>Fixed</CouponType> <CurrencyCode>sample string 3</CurrencyCode> <DataFeedId>1</DataFeedId> <DateOffset>1</DateOffset> <DayCount>ACT_ACT</DayCount> <DefaultDate>2024-11-23T01:50:38.4967251-06:00</DefaultDate> <DefaultType>sample string 4</DefaultType> <FirstCouponDate>2024-11-23T01:50:38.4967251-06:00</FirstCouponDate> <FirstSettleDate>2024-11-23T01:50:38.4967251-06:00</FirstSettleDate> <FixedRate>1.1</FixedRate> <GuarantorId>1</GuarantorId> <HasAttachedWarrants>true</HasAttachedWarrants> <HasDefaulted>true</HasDefaulted> <HasFXRisk>true</HasFXRisk> <HolidayCalendarId>1</HolidayCalendarId> <InsurerId>1</InsurerId> <InterestAccrualDate>2024-11-23T01:50:38.4977254-06:00</InterestAccrualDate> <IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled> <IsEmergingMarket>true</IsEmergingMarket> <IsInterestOnly>true</IsInterestOnly> <IsMostSeniorTranche>true</IsMostSeniorTranche> <IsPrincipalOnly>true</IsPrincipalOnly> <IsPrivate>true</IsPrivate> <IsRestructured>true</IsRestructured> <IsStructuredFinanceObligation>true</IsStructuredFinanceObligation> <IsSynthetic>true</IsSynthetic> <IsTradedAccrued>true</IsTradedAccrued> <Issue>sample string 18</Issue> <IssueDate>2024-11-23T01:50:38.4977254-06:00</IssueDate> <IssuePrice>1.1</IssuePrice> <IssueSize>1</IssueSize> <IssuerId>19</IssuerId> <LeadUnderwriterId>1</LeadUnderwriterId> <LockoutDays>22</LockoutDays> <MaturityDate>2024-11-23T01:50:38.4987252-06:00</MaturityDate> <MaturityDateExpected>2024-11-23T01:50:38.4987252-06:00</MaturityDateExpected> <Notes>sample string 25</Notes> <OriginalCapPercentage>26.1</OriginalCapPercentage> <PayNonBusinessDirection>On</PayNonBusinessDirection> <PayOffsetDays>27</PayOffsetDays> <PayOffsetDirection>After</PayOffsetDirection> <PayOffsetType>BusinessDays</PayOffsetType> <PaysEndOfMonth>true</PaysEndOfMonth> <RateOptionId>1</RateOptionId> <RegistrationType>sample string 29</RegistrationType> <SeniorityId>1</SeniorityId> <SpreadRate>1.1</SpreadRate> <TransferAgentId>1</TransferAgentId> </AbsAdd>
application/x-www-form-urlencoded
Sample not available.
Response Information
Abs
Name
Description
Type
Additional Information
AssetBackedSecurityName
The name of the asset in WSO which typically includes the coupon rate and maturity date
string
AssetClassId
The class of the asset set by the user
integer
Collateral
The description of the collateral that is backing the asset
string
CountryId
The legal country for this asset by ID value
integer
CouponDateOffset
Business Day Offset - this determines when a coupon should pay if the coupon date falls on a non-business day
CouponFrequency
The Coupon Frequency indicates how many times a year there is a coupon payment
CurrencyCode
The currency type for this ABS by ID value
string
DataFeedId
The external data import source for this asset by ID value
integer
DateOffset
Given the type of coupon - this is the number of days to offset the coupon rate
integer
DefaultDate
The date that the asset went into default status
date
DefaultType
The type of default that has occurred on the asset
string
FirstCouponDate
The first coupon payment date for the asset
date
FirstSettleDate
The first settle date listed for the asset
date
FixedRate
The fixed coupon rate
decimal number
GuarantorId
The guarantor for the asset by ID value
integer
HasAttachedWarrants
The flag indicating if the asset has attached warrants
boolean
HasDefaulted
The flag indicating if the asset has defaulted
boolean
HasFXRisk
The flag indicating if the asset has foreign exchange risk
boolean
HolidayCalendarId
The holiday calendar for the asset by ID value
integer
Id
The WSO ID for the asset
integer
InsurerId
The insurer of the asset by ID value
integer
InterestAccrualDate
The first date that the asset starts accruing interest
date
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this ABS asset.
boolean
IsDeleted
A flag indicating if the ABS asset is soft-deleted in the system
boolean
IsEmergingMarket
The flag indicating if the ABS asset is from an emerging market
boolean
IsInterestOnly
The flag indicating if this is an interest only asset
boolean
IsMostSeniorTranche
The flag indicating if the asset is the most senior tranche
boolean
IsPrincipalOnly
The flag indicating if this is a principal only asset
boolean
IsPrivate
The flag indicating if this is a private security
boolean
IsRestructured
The flag indicating if the security has been restructured since it was initially issued
boolean
IsStructuredFinanceObligation
The flag indicating if the asset belongs to a structured finance obligation
boolean
Issue
The issue description of the asset
string
IssueDate
The date that the asset was officially issued
date
IssuePrice
The original price at which the asset was issued
decimal number
IssueSize
The original global amount of the asset at issuance
decimal number
IsSynthetic
The flag indicating if this a synthetic security
boolean
IsTradedAccrued
The flag indicating if the asset trades with accrued interest
boolean
LeadUnderwriterId
The lead underwriting bank of the asset by ID value
integer
LockoutDays
integer
MaturityDate
The maturity date of the asset
date
MaturityDateExpected
The expected maturity date of the asset - optional field
date
Notes
The notes regarding the asset
string
OriginalCapPercentage
The original capitalized percentage of the asset
decimal number
PayNonBusinessDirection
Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay
PayOffsetDays
Pay Offset - the number of days that coupon payment occurs differing from the coupon date
integer
PaysEndOfMonth
The flag indicating if this asset pays end of month when the first coupon date does not fall on the 31st
boolean
RateOptionId
The rate option for the asset
integer
RegistrationType
The registration type
string
SeniorityId
The seniority level of the ABS asset by ID value
integer
SpreadRate
The spread rate of the ABS asset
decimal number
TransferAgentId
The agent responsible for issuing certificates listed by ID value
integer
Response Body Formats
application/json, text/json
{
"couponRates": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"coupons": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"id": 1,
"assetBackedSecurityName": "sample string 2",
"assetClassId": 1,
"collateral": "sample string 3",
"countryId": 1,
"currencyCode": "sample string 4",
"couponDateOffset": "None",
"couponFrequency": "Annual",
"couponType": "Fixed",
"dataFeedId": 1,
"dateOffset": 1,
"dayCount": "ACT_ACT",
"defaultDate": "2024-11-23T01:50:38.5780279-06:00",
"defaultType": "sample string 5",
"firstCouponDate": "2024-11-23T01:50:38.5780279-06:00",
"firstSettleDate": "2024-11-23T01:50:38.5780279-06:00",
"fixedRate": 1.1,
"guarantorId": 1,
"hasAttachedWarrants": true,
"hasFXRisk": true,
"holidayCalendarId": 1,
"insurerId": 1,
"interestAccrualDate": "2024-11-23T01:50:38.5780279-06:00",
"hasDefaulted": true,
"isEmergingMarket": true,
"isInterestOnly": true,
"isMostSeniorTranche": true,
"isPrincipalOnly": true,
"isPrivate": true,
"isBaseRateObservationShiftEnabled": true,
"isRestructured": true,
"isStructuredFinanceObligation": true,
"issue": "sample string 19",
"issueDate": "2024-11-23T01:50:38.5780279-06:00",
"issuePrice": 1.1,
"issuer": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"issueSize": 1.0,
"isSynthetic": true,
"isTradedAccrued": true,
"leadUnderwriterId": 1,
"lockoutDays": 22,
"maturityDate": "2024-11-23T01:50:38.5780279-06:00",
"maturityDateExpected": "2024-11-23T01:50:38.5780279-06:00",
"notes": "sample string 25",
"originalCapPercentage": 26.1,
"payNonBusinessDirection": "On",
"payOffsetDays": 27,
"payOffsetDirection": "After",
"payOffsetType": "BusinessDays",
"paysEndOfMonth": true,
"rateOptionId": 1,
"registrationType": "sample string 29",
"seniorityId": 1,
"spreadRate": 1.1,
"transferAgentId": 1,
"isDeleted": true,
"links": [
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
}
],
"attributables": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"identifiers": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"ratings": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"udfs": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"baseRateInterestMethod": "Unassigned",
"baseRateCompoundMethod": "Unassigned"
}
application/xml, text/xml
<Abs xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AssetBackedSecurityName>sample string 2</AssetBackedSecurityName>
<AssetClassId>1</AssetClassId>
<Attributables>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Attributables>
<BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod>
<BaseRateInterestMethod>Unassigned</BaseRateInterestMethod>
<Collateral>sample string 3</Collateral>
<CountryId>1</CountryId>
<CouponDateOffset>None</CouponDateOffset>
<CouponFrequency>Annual</CouponFrequency>
<CouponRates>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</CouponRates>
<CouponType>Fixed</CouponType>
<Coupons>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Coupons>
<CurrencyCode>sample string 4</CurrencyCode>
<DataFeedId>1</DataFeedId>
<DateOffset>1</DateOffset>
<DayCount>ACT_ACT</DayCount>
<DefaultDate>2024-11-23T01:50:38.5780279-06:00</DefaultDate>
<DefaultType>sample string 5</DefaultType>
<FirstCouponDate>2024-11-23T01:50:38.5780279-06:00</FirstCouponDate>
<FirstSettleDate>2024-11-23T01:50:38.5780279-06:00</FirstSettleDate>
<FixedRate>1.1</FixedRate>
<GuarantorId>1</GuarantorId>
<HasAttachedWarrants>true</HasAttachedWarrants>
<HasDefaulted>true</HasDefaulted>
<HasFXRisk>true</HasFXRisk>
<HolidayCalendarId>1</HolidayCalendarId>
<Id>1</Id>
<Identifiers>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Identifiers>
<InsurerId>1</InsurerId>
<InterestAccrualDate>2024-11-23T01:50:38.5780279-06:00</InterestAccrualDate>
<IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled>
<IsDeleted>true</IsDeleted>
<IsEmergingMarket>true</IsEmergingMarket>
<IsInterestOnly>true</IsInterestOnly>
<IsMostSeniorTranche>true</IsMostSeniorTranche>
<IsPrincipalOnly>true</IsPrincipalOnly>
<IsPrivate>true</IsPrivate>
<IsRestructured>true</IsRestructured>
<IsStructuredFinanceObligation>true</IsStructuredFinanceObligation>
<IsSynthetic>true</IsSynthetic>
<IsTradedAccrued>true</IsTradedAccrued>
<Issue>sample string 19</Issue>
<IssueDate>2024-11-23T01:50:38.5780279-06:00</IssueDate>
<IssuePrice>1.1</IssuePrice>
<IssueSize>1</IssueSize>
<Issuer>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Issuer>
<LeadUnderwriterId>1</LeadUnderwriterId>
<Links>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
</Links>
<LockoutDays>22</LockoutDays>
<MaturityDate>2024-11-23T01:50:38.5780279-06:00</MaturityDate>
<MaturityDateExpected>2024-11-23T01:50:38.5780279-06:00</MaturityDateExpected>
<Notes>sample string 25</Notes>
<OriginalCapPercentage>26.1</OriginalCapPercentage>
<PayNonBusinessDirection>On</PayNonBusinessDirection>
<PayOffsetDays>27</PayOffsetDays>
<PayOffsetDirection>After</PayOffsetDirection>
<PayOffsetType>BusinessDays</PayOffsetType>
<PaysEndOfMonth>true</PaysEndOfMonth>
<RateOptionId>1</RateOptionId>
<Ratings>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Ratings>
<RegistrationType>sample string 29</RegistrationType>
<SeniorityId>1</SeniorityId>
<SpreadRate>1.1</SpreadRate>
<TransferAgentId>1</TransferAgentId>
<Udfs>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Udfs>
</Abs>