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)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      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.

    • getBankAccountToken

      public Token getBankAccountToken()
      Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.

      If you can't use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you're responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information isn't sent directly to Stripe, so we can't determine how it's handled or stored.

      You can't store or use tokens more than once. To store card or bank account information for later use, create Customer objects or External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

    • getClientSecret

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

    • getFilters

      public Session.Filters getFilters()

    • getLimits

      public Session.Limits getLimits()

    • getLivemode

      public Boolean getLivemode()
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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

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

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

    • setBankAccountToken

      public void setBankAccountToken(Token bankAccountToken)
      Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.

      If you can't use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you're responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer's information isn't sent directly to Stripe, so we can't determine how it's handled or stored.

      You can't store or use tokens more than once. To store card or bank account information for later use, create Customer objects or External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

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

    • setId

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

    • setLimits

      public void setLimits(Session.Limits limits)

    • setLivemode

      public void setLivemode(Boolean livemode)
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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

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

    • 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