Package com.stripe.model

Class AccountSession

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.AccountSession
All Implemented Interfaces:
StripeActiveObject, StripeObjectInterface
public class AccountSession extends ApiResource
An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.

We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once.

Related guide: Connect embedded components

  • Constructor Details

    • AccountSession

      public AccountSession()

  • Method Details

    • create

      public static AccountSession create(Map<String,Object> params) throws StripeException
      Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
      Throws:
      StripeException

    • create

      public static AccountSession create(Map<String,Object> params, RequestOptions options) throws StripeException
      Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
      Throws:
      StripeException

    • create

      public static AccountSession create(AccountSessionCreateParams params) throws StripeException
      Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
      Throws:
      StripeException

    • create

      public static AccountSession create(AccountSessionCreateParams params, RequestOptions options) throws StripeException
      Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Whether the embedded component is enabled.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAccount

      public String getAccount()
      The ID of the account the AccountSession was created for.

    • getClientSecret

      public String getClientSecret()
      The client secret of this AccountSession. Used on the client to set up secure access to the given account.

      The client secret can be used to provide access to account from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.

      Refer to our docs to setup Connect embedded components and learn about how client_secret should be handled.

    • getComponents

      public AccountSession.Components getComponents()

    • getExpiresAt

      public Long getExpiresAt()
      The timestamp at which this AccountSession will expire.

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

    • getObject

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

      Equal to account_session.

    • setAccount

      public void setAccount(String account)
      The ID of the account the AccountSession was created for.

    • setClientSecret

      public void setClientSecret(String clientSecret)
      The client secret of this AccountSession. Used on the client to set up secure access to the given account.

      The client secret can be used to provide access to account from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.

      Refer to our docs to setup Connect embedded components and learn about how client_secret should be handled.

    • setComponents

      public void setComponents(AccountSession.Components components)

    • setExpiresAt

      public void setExpiresAt(Long expiresAt)
      The timestamp at which this AccountSession will expire.

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

    • setObject

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

      Equal to account_session.

    • 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