Package com.plaid.client.model

Class Security

java.lang.Object
com.plaid.client.model.Security
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class Security
extends java.lang.Object
Contains details about a security

  • Field Details

  • Constructor Details

  • Method Details

    • securityId

      public Security securityId​(java.lang.String securityId)

    • getSecurityId

      public java.lang.String getSecurityId()
      A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the `security_id` is case sensitive.
      Returns:
      securityId

    • setSecurityId

      public void setSecurityId​(java.lang.String securityId)

    • isin

      public Security isin​(java.lang.String isin)

    • getIsin

      @Nullable public java.lang.String getIsin()
      12-character ISIN, a globally unique securities identifier.
      Returns:
      isin

    • setIsin

      public void setIsin​(java.lang.String isin)

    • cusip

      public Security cusip​(java.lang.String cusip)

    • getCusip

      @Nullable public java.lang.String getCusip()
      9-character CUSIP, an identifier assigned to North American securities.
      Returns:
      cusip

    • setCusip

      public void setCusip​(java.lang.String cusip)

    • sedol

      public Security sedol​(java.lang.String sedol)

    • getSedol

      @Nullable public java.lang.String getSedol()
      7-character SEDOL, an identifier assigned to securities in the UK.
      Returns:
      sedol

    • setSedol

      public void setSedol​(java.lang.String sedol)

    • institutionSecurityId

      public Security institutionSecurityId​(java.lang.String institutionSecurityId)

    • getInstitutionSecurityId

      @Nullable public java.lang.String getInstitutionSecurityId()
      An identifier given to the security by the institution
      Returns:
      institutionSecurityId

    • setInstitutionSecurityId

      public void setInstitutionSecurityId​(java.lang.String institutionSecurityId)

    • institutionId

      public Security institutionId​(java.lang.String institutionId)

    • getInstitutionId

      @Nullable public java.lang.String getInstitutionId()
      If `institution_security_id` is present, this field indicates the Plaid `institution_id` of the institution to whom the identifier belongs.
      Returns:
      institutionId

    • setInstitutionId

      public void setInstitutionId​(java.lang.String institutionId)

    • proxySecurityId

      public Security proxySecurityId​(java.lang.String proxySecurityId)

    • getProxySecurityId

      @Nullable public java.lang.String getProxySecurityId()
      In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.
      Returns:
      proxySecurityId

    • setProxySecurityId

      public void setProxySecurityId​(java.lang.String proxySecurityId)

    • name

      public Security name​(java.lang.String name)

    • getName

      @Nullable public java.lang.String getName()
      A descriptive name for the security, suitable for display.
      Returns:
      name

    • setName

      public void setName​(java.lang.String name)

    • tickerSymbol

      public Security tickerSymbol​(java.lang.String tickerSymbol)

    • getTickerSymbol

      @Nullable public java.lang.String getTickerSymbol()
      The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
      Returns:
      tickerSymbol

    • setTickerSymbol

      public void setTickerSymbol​(java.lang.String tickerSymbol)

    • isCashEquivalent

      public Security isCashEquivalent​(java.lang.Boolean isCashEquivalent)

    • getIsCashEquivalent

      @Nullable public java.lang.Boolean getIsCashEquivalent()
      Indicates that a security is a highly liquid asset and can be treated like cash.
      Returns:
      isCashEquivalent

    • setIsCashEquivalent

      public void setIsCashEquivalent​(java.lang.Boolean isCashEquivalent)

    • type

      public Security type​(java.lang.String type)

    • getType

      @Nullable public java.lang.String getType()
      The security type of the holding. Valid security types are: `cash`: Cash, currency, and money market funds `derivative`: Options, warrants, and other derivative instruments `equity`: Domestic and foreign equities `etf`: Multi-asset exchange-traded investment funds `fixed income`: Bonds and certificates of deposit (CDs) `loan`: Loans and loan receivables. `mutual fund`: Open- and closed-end vehicles pooling funds of multiple investors. `other`: Unknown or other investment types
      Returns:
      type

    • setType

      public void setType​(java.lang.String type)

    • closePrice

      public Security closePrice​(java.lang.Double closePrice)

    • getClosePrice

      @Nullable public java.lang.Double getClosePrice()
      Price of the security at the close of the previous trading session. `null` for non-public securities. If the security is a foreign currency or a cryptocurrency this field will be updated daily and will be priced in USD.
      Returns:
      closePrice

    • setClosePrice

      public void setClosePrice​(java.lang.Double closePrice)

    • closePriceAsOf

      public Security closePriceAsOf​(java.time.LocalDate closePriceAsOf)

    • getClosePriceAsOf

      @Nullable public java.time.LocalDate getClosePriceAsOf()
      Date for which `close_price` is accurate. Always `null` if `close_price` is `null`.
      Returns:
      closePriceAsOf

    • setClosePriceAsOf

      public void setClosePriceAsOf​(java.time.LocalDate closePriceAsOf)

    • isoCurrencyCode

      public Security isoCurrencyCode​(java.lang.String isoCurrencyCode)

    • getIsoCurrencyCode

      @Nullable public java.lang.String getIsoCurrencyCode()
      The ISO-4217 currency code of the price given. Always `null` if `unofficial_currency_code` is non-`null`.
      Returns:
      isoCurrencyCode

    • setIsoCurrencyCode

      public void setIsoCurrencyCode​(java.lang.String isoCurrencyCode)

    • unofficialCurrencyCode

      public Security unofficialCurrencyCode​(java.lang.String unofficialCurrencyCode)

    • getUnofficialCurrencyCode

      @Nullable public java.lang.String getUnofficialCurrencyCode()
      The unofficial currency code associated with the security. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
      Returns:
      unofficialCurrencyCode

    • setUnofficialCurrencyCode

      public void setUnofficialCurrencyCode​(java.lang.String unofficialCurrencyCode)

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object