GET v1/BankDeals/{id}

Description

Retrieve a bank deal with WSO ID of {id}.

Base Url

https://services.wsoweb.com/


Rest Call Syntax


GET SecurityMaster/v1/BankDeals/{id}

GET SecurityMaster/v1/BankDeals/{id}

Verb

Base Url

URI parameters

 = 

Authentication



Response Format


Headers

Add header


 

Delete




Limitations

There are no limitations specified.




Request Information


Parameters

Name

Description

Type

Additional Information

id

WSO ID of the bank deal

integer

Required




Response Information



BankDeal

Name

Description

Type

Additional Information

AgentBank

Link to the Agent Bank

AgentBankName

The agent bank for this bank deal.

string

AgentConsent

Agent Consent

boolean

AgentContact

Link to the Agent Contact

AgentStreetName

Agent Street Name

string

BankDealName

The name of the bank deal - usually formatted to the date of the credit agreement

string

BorrowerConsent

Borrower Consent

boolean

CanAffiliate

Can Affiliate

boolean

CreditDate

The date of the credit agreement

date

Currency

Link to Currency

CurrencyCode

The CurrencyCode for this ABS

string

DaysOfFolowingMonthRuleDateType

Pricing grid date type for number of days of following month after the receipt of the compliance certificate

DaysOfFolowingMonthRuleDays

Number of days of the following month after the receipt of the compliance certificate

Description

The official description of this bank deal

string

EffectiveDate

Effective of the pricing grid

date

FundingDate

The funding date of the bank deal

date

GlobalAmount

The total original global amount for all of the facilities in this bank deal

decimal number

GlobalId

The Global Id of the BankDeal

integer

Id

WSO ID of the bank deal

integer

Identifiers

Link to Identifiers

IsCovenantLite

The Covenant Lite flag for this bank deal

boolean

IsDeleted

Indicates if the bank deal been soft deleted from the system

boolean

IsLookupExchangeRate

Look up exchange rate from FX Rates Browser when setting up foreign currency contracts

boolean

IsPricingGridEnabled

Is Pricing Grid Enabled

boolean

Issuer

The issuer related to this bank deal

LeadUnderwriter

Link to the LeadUnderwriter

LeadUnderwriterName

The lead underwriter name of this bank deal.

string

Links

The Hateoas links related to this entity

Collection of Link

MinimumAssignment

Minimum Assignment

decimal number

MinimumHold

Minimum Hold

decimal number

Notes

Notes about the bank deal

string

OffsetDaysForFXRateLookup

Number of days before contract start date to look up. Exchange rate will be look up for contract start date - OffsetDaysForFXRateLookup.

integer

PrepaymentNotes

Amortization guidelines

string

PricingGridEffectiveDateRule

Pricing Grid Effective Date Rule

PrimarySponsor

Link to the PrimarySponsor

PrimarySponsorName

The primary sponser (bank object) of this bank deal.

string

Sponsor2

Link to the second sponsor (bank object) of this bank deal.

Sponsor2Name

The second sponsor (bank object) of this bank deal.

string

Sponsor3

Link to the third sponsor (bank object) of this bank deal.

Sponsor3Name

The third sponsor (bank object) of this bank deal.

string

TPlusRuleDateType

Pricing grid date type for t plus effective date rule

TPlusRuleDays

Number of days after the receipt of the compliance certificate

integer

Udfs

Link to Udfs




Response Body Formats



application/json, text/json

Sample:
{
  "minimumAssignment": 1.0,
  "minimumHold": 1.0,
  "agentConsent": true,
  "canAffiliate": true,
  "borrowerConsent": true,
  "agentStreetName": "sample string 4",
  "isDeleted": true,
  "id": 6,
  "bankDealName": "sample string 7",
  "agentBank": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "agentContact": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "currencyCode": "sample string 9",
  "currency": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "daysOfFolowingMonthRuleDays": "None",
  "daysOfFolowingMonthRuleDateType": "BusinessDays",
  "effectiveDate": "2024-11-23T01:20:04.9266375-06:00",
  "isPricingGridEnabled": true,
  "leadUnderwriter": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "pricingGridEffectiveDateRule": "None",
  "primarySponsor": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "sponsor2": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "sponsor3": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "tPlusRuleDays": 12,
  "tPlusRuleDateType": "BusinessDays",
  "issuer": {
    "verb": "sample string 1",
    "rel": "sample string 2",
    "uri": "http://webapihelppage3.com"
  },
  "creditDate": "2024-11-23T01:20:04.9272288-06:00",
  "description": "sample string 13",
  "globalAmount": 1.0,
  "notes": "sample string 14",
  "prepaymentNotes": "sample string 15",
  "isCovenantLite": true,
  "fundingDate": "2024-11-23T01:20:04.9272288-06:00",
  "identifiers": {
    "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"
  },
  "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"
    }
  ],
  "isLookupExchangeRate": true,
  "offsetDaysForFXRateLookup": 19,
  "agentBankName": "sample string 21",
  "leadUnderwriterName": "sample string 22",
  "primarySponsorName": "sample string 23",
  "sponsor2Name": "sample string 24",
  "sponsor3Name": "sample string 25",
  "globalId": 1
}

application/xml, text/xml

Sample:
<BankDeal xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <AgentBank>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </AgentBank>
  <AgentBankName>sample string 21</AgentBankName>
  <AgentConsent>true</AgentConsent>
  <AgentContact>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </AgentContact>
  <AgentStreetName>sample string 4</AgentStreetName>
  <BankDealName>sample string 7</BankDealName>
  <BorrowerConsent>true</BorrowerConsent>
  <CanAffiliate>true</CanAffiliate>
  <CreditDate>2024-11-23T01:20:04.9272288-06:00</CreditDate>
  <Currency>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Currency>
  <CurrencyCode>sample string 9</CurrencyCode>
  <DaysOfFolowingMonthRuleDateType>BusinessDays</DaysOfFolowingMonthRuleDateType>
  <DaysOfFolowingMonthRuleDays>None</DaysOfFolowingMonthRuleDays>
  <Description>sample string 13</Description>
  <EffectiveDate>2024-11-23T01:20:04.9266375-06:00</EffectiveDate>
  <FundingDate>2024-11-23T01:20:04.9272288-06:00</FundingDate>
  <GlobalAmount>1</GlobalAmount>
  <GlobalId>1</GlobalId>
  <Id>6</Id>
  <Identifiers>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Identifiers>
  <IsCovenantLite>true</IsCovenantLite>
  <IsDeleted>true</IsDeleted>
  <IsLookupExchangeRate>true</IsLookupExchangeRate>
  <IsPricingGridEnabled>true</IsPricingGridEnabled>
  <Issuer>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Issuer>
  <LeadUnderwriter>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </LeadUnderwriter>
  <LeadUnderwriterName>sample string 22</LeadUnderwriterName>
  <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>
  <MinimumAssignment>1</MinimumAssignment>
  <MinimumHold>1</MinimumHold>
  <Notes>sample string 14</Notes>
  <OffsetDaysForFXRateLookup>19</OffsetDaysForFXRateLookup>
  <PrepaymentNotes>sample string 15</PrepaymentNotes>
  <PricingGridEffectiveDateRule>None</PricingGridEffectiveDateRule>
  <PrimarySponsor>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </PrimarySponsor>
  <PrimarySponsorName>sample string 23</PrimarySponsorName>
  <Sponsor2>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Sponsor2>
  <Sponsor2Name>sample string 24</Sponsor2Name>
  <Sponsor3>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Sponsor3>
  <Sponsor3Name>sample string 25</Sponsor3Name>
  <TPlusRuleDateType>BusinessDays</TPlusRuleDateType>
  <TPlusRuleDays>12</TPlusRuleDays>
  <Udfs>
    <Rel>sample string 2</Rel>
    <Uri>http://webapihelppage3.com/</Uri>
    <Verb>sample string 1</Verb>
  </Udfs>
</BankDeal>



Feedback



(0 out of 1500 characters used)
Feedback has been submitted. Thank you for your feedback.
Automatic feedback submission has been turned off by your system administrator. Your feedback has been logged to the exceptions table. Please contact support to find out how to manually send in your feedback. Thank you.