Package com.stripe.model.financialconnections

Class Institution

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.financialconnections.Institution
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Institution extends ApiResource implements HasId
An institution represents a financial institution to which an end user can connect using the Financial Connections authentication flow.

  • Constructor Details

    • Institution

      public Institution()

  • Method Details

    • list

      public static InstitutionCollection list(Map<String,Object> params) throws StripeException
      Returns a list of Financial Connections Institution objects.
      Throws:
      StripeException

    • list

      public static InstitutionCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a list of Financial Connections Institution objects.
      Throws:
      StripeException

    • list

      public static InstitutionCollection list(InstitutionListParams params) throws StripeException
      Returns a list of Financial Connections Institution objects.
      Throws:
      StripeException

    • list

      public static InstitutionCollection list(InstitutionListParams params, RequestOptions options) throws StripeException
      Returns a list of Financial Connections Institution objects.
      Throws:
      StripeException

    • retrieve

      public static Institution retrieve(String institution) throws StripeException
      Retrieves the details of a Financial Connections Institution.
      Throws:
      StripeException

    • retrieve

      public static Institution retrieve(String institution, RequestOptions options) throws StripeException
      Retrieves the details of a Financial Connections Institution.
      Throws:
      StripeException

    • retrieve

      public static Institution retrieve(String institution, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of a Financial Connections Institution.
      Throws:
      StripeException

    • retrieve

      public static Institution retrieve(String institution, InstitutionRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of a Financial Connections Institution.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Whether the given feature is supported by this institution.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getCountries

      public List<String> getCountries()
      The list of countries supported by this institution, formatted as ISO country codes.

    • getFeatures

      public Institution.Features getFeatures()

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getName

      public String getName()
      The name of this institution.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to financial_connections.institution.

    • getRoutingNumbers

      public List<String> getRoutingNumbers()
      A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.

    • getStatus

      public String getStatus()
      The status of this institution in the Financial Connections authentication flow.

      One of active, degraded, or inactive.

    • getUrl

      public String getUrl()
      A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.

    • setCountries

      public void setCountries(List<String> countries)
      The list of countries supported by this institution, formatted as ISO country codes.

    • setFeatures

      public void setFeatures(Institution.Features features)

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setName

      public void setName(String name)
      The name of this institution.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to financial_connections.institution.

    • setRoutingNumbers

      public void setRoutingNumbers(List<String> routingNumbers)
      A list of routing numbers which are known to correspond to this institution. Due to the many to many relationship between institutions and routing numbers, this list may not be comprehensive and routing numbers may also be shared between institutions.

    • setStatus

      public void setStatus(String status)
      The status of this institution in the Financial Connections authentication flow.

      One of active, degraded, or inactive.

    • setUrl

      public void setUrl(String url)
      A URL corresponding to this institution. This URL is also displayed in the authentication flow to help end users confirm that they are authenticating with the right institution.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId