Package com.stripe.model.financialconnections

Class Session

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.financialconnections.Session
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class Session extends ApiResource implements HasId
A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

  • Constructor Details

    • Session

      public Session()

  • Method Details

    • create

      public static Session create(Map<String,Object> params) throws StripeException
      To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
      Throws:
      StripeException

    • create

      public static Session create(Map<String,Object> params, RequestOptions options) throws StripeException
      To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
      Throws:
      StripeException

    • create

      public static Session create(SessionCreateParams params) throws StripeException
      To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
      Throws:
      StripeException

    • create

      public static Session create(SessionCreateParams params, RequestOptions options) throws StripeException
      To launch the Financial Connections authorization flow, create a Session. The session’s client_secret can be used to launch the flow using Stripe.js.
      Throws:
      StripeException

    • retrieve

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

    • retrieve

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

    • retrieve

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

    • retrieve

      public static Session retrieve(String session, SessionRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of a Financial Connections Session.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      The reason for the Session being cancelled.

      One of custom_manual_entry, or other.

      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccountHolder

      public Session.AccountHolder getAccountHolder()
      The account holder for whom accounts are collected in this session.

    • getAccounts

      public AccountCollection getAccounts()
      The accounts that were collected as part of this Session.

    • getClientSecret

      public String getClientSecret()
      A value that will be passed to the client to launch the authentication flow.

    • getFilters

      public Session.Filters getFilters()

    • getHosted

      public Session.Hosted getHosted()
      Settings for the Hosted UI mode.

    • getLimits

      public Session.Limits getLimits()

    • 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.

    • getManualEntry

      public Session.ManualEntry getManualEntry()

    • getObject

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

      Equal to financial_connections.session.

    • getPermissions

      public List<String> getPermissions()
      Permissions requested for accounts collected during this session.

    • getPrefetch

      public List<String> getPrefetch()
      Data features requested to be retrieved upon account creation.

    • getRelinkOptions

      public Session.RelinkOptions getRelinkOptions()

    • getRelinkResult

      public Session.RelinkResult getRelinkResult()

    • getReturnUrl

      public String getReturnUrl()
      For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

    • getStatus

      public String getStatus()
      The current state of the session.

      One of cancelled, failed, pending, or succeeded.

    • getStatusDetails

      public Session.StatusDetails getStatusDetails()

    • getUiMode

      public String getUiMode()
      The UI mode for this session.

      One of hosted, or modal.

    • getUrl

      public String getUrl()
      The hosted URL for this Session. Redirect customers to this URL to take them to the hosted authentication flow. This value is only present when the Session is active and the ui_mode is hosted.

    • setAccountHolder

      public void setAccountHolder(Session.AccountHolder accountHolder)
      The account holder for whom accounts are collected in this session.

    • setAccounts

      public void setAccounts(AccountCollection accounts)
      The accounts that were collected as part of this Session.

    • setClientSecret

      public void setClientSecret(String clientSecret)
      A value that will be passed to the client to launch the authentication flow.

    • setFilters

      public void setFilters(Session.Filters filters)

    • setHosted

      public void setHosted(Session.Hosted hosted)
      Settings for the Hosted UI mode.

    • setId

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

    • setLimits

      public void setLimits(Session.Limits limits)

    • 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.

    • setManualEntry

      public void setManualEntry(Session.ManualEntry manualEntry)

    • 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.session.

    • setPermissions

      public void setPermissions(List<String> permissions)
      Permissions requested for accounts collected during this session.

    • setPrefetch

      public void setPrefetch(List<String> prefetch)
      Data features requested to be retrieved upon account creation.

    • setRelinkOptions

      public void setRelinkOptions(Session.RelinkOptions relinkOptions)

    • setRelinkResult

      public void setRelinkResult(Session.RelinkResult relinkResult)

    • setReturnUrl

      public void setReturnUrl(String returnUrl)
      For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.

    • setStatus

      public void setStatus(String status)
      The current state of the session.

      One of cancelled, failed, pending, or succeeded.

    • setStatusDetails

      public void setStatusDetails(Session.StatusDetails statusDetails)

    • setUiMode

      public void setUiMode(String uiMode)
      The UI mode for this session.

      One of hosted, or modal.

    • setUrl

      public void setUrl(String url)
      The hosted URL for this Session. Redirect customers to this URL to take them to the hosted authentication flow. This value is only present when the Session is active and the ui_mode is hosted.

    • 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