View Source Stripe.AccountSession (stripity_stripe v3.3.1)

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

Summary

Types

account_management()

Configuration for the account management embedded component.

account_onboarding()

Configuration for the account onboarding embedded component.

balances()

Configuration for the balances embedded component.

components()

Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).

disputes_list()

Configuration for the disputes list embedded component.

documents()

Configuration for the documents embedded component.

features()

The list of features enabled in the embedded component.

financial_account()

Configuration for the financial account embedded component.

financial_account_transactions()

Configuration for the financial account transactions embedded component.

instant_payouts_promotion()

Configuration for the instant payouts promotion embedded component.

issuing_card()

Configuration for the issuing card embedded component.

issuing_cards_list()

Configuration for the issuing cards list embedded component.

notification_banner()

Configuration for the notification banner embedded component.

payment_details()

Configuration for the payment details embedded component.

payment_disputes()

Configuration for the payment disputes embedded component.

payments()

Configuration for the payments embedded component.

payout_details()

Configuration for the payout details embedded component.

payouts()

Configuration for the payouts embedded component.

payouts_list()

Configuration for the payouts list embedded component.

t()

The account_session type.

tax_registrations()

Configuration for the tax registrations embedded component.

tax_settings()

Configuration for the tax settings embedded component.

Functions

create(params \\ %{}, opts \\ [])

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.

Types

account_management()

@type account_management() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the account management embedded component.

account_onboarding()

@type account_onboarding() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the account onboarding embedded component.

balances()

@type balances() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the balances embedded component.

components()

@type components() :: %{
  optional(:account_management) => account_management(),
  optional(:account_onboarding) => account_onboarding(),
  optional(:balances) => balances(),
  optional(:disputes_list) => disputes_list(),
  optional(:documents) => documents(),
  optional(:financial_account) => financial_account(),
  optional(:financial_account_transactions) => financial_account_transactions(),
  optional(:instant_payouts_promotion) => instant_payouts_promotion(),
  optional(:issuing_card) => issuing_card(),
  optional(:issuing_cards_list) => issuing_cards_list(),
  optional(:notification_banner) => notification_banner(),
  optional(:payment_details) => payment_details(),
  optional(:payment_disputes) => payment_disputes(),
  optional(:payments) => payments(),
  optional(:payout_details) => payout_details(),
  optional(:payouts) => payouts(),
  optional(:payouts_list) => payouts_list(),
  optional(:tax_registrations) => tax_registrations(),
  optional(:tax_settings) => tax_settings()
}

Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).

disputes_list()

@type disputes_list() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the disputes list embedded component.

documents()

@type documents() :: %{optional(:enabled) => boolean(), optional(:features) => map()}

Configuration for the documents embedded component.

features()

@type features() :: %{
  optional(:capture_payments) => boolean(),
  optional(:destination_on_behalf_of_charge_management) => boolean(),
  optional(:dispute_management) => boolean(),
  optional(:refund_management) => boolean()
}

The list of features enabled in the embedded component.

financial_account()

@type financial_account() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the financial account embedded component.

financial_account_transactions()

@type financial_account_transactions() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the financial account transactions embedded component.

instant_payouts_promotion()

@type instant_payouts_promotion() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the instant payouts promotion embedded component.

issuing_card()

@type issuing_card() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the issuing card embedded component.

issuing_cards_list()

@type issuing_cards_list() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the issuing cards list embedded component.

notification_banner()

@type notification_banner() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the notification banner embedded component.

payment_details()

@type payment_details() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the payment details embedded component.

payment_disputes()

@type payment_disputes() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the payment disputes embedded component.

payments()

@type payments() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the payments embedded component.

payout_details()

@type payout_details() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => map()
}

Configuration for the payout details embedded component.

payouts()

@type payouts() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => features()
}

Configuration for the payouts embedded component.

payouts_list()

@type payouts_list() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => map()
}

Configuration for the payouts list embedded component.

t()

@type t() :: %Stripe.AccountSession{
  account: binary(),
  client_secret: binary(),
  components: term(),
  expires_at: integer(),
  livemode: boolean(),
  object: binary()
}

The account_session type.

account The ID of the account the AccountSession was created for
client_secret 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.

components
expires_at The timestamp at which this AccountSession will expire.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.

tax_registrations()

@type tax_registrations() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => map()
}

Configuration for the tax registrations embedded component.

tax_settings()

@type tax_settings() :: %{
  optional(:enabled) => boolean(),
  optional(:features) => map()
}

Configuration for the tax settings embedded component.

Functions

create(params \\ %{}, opts \\ [])

@spec create(
  params :: %{
    optional(:account) => binary(),
    optional(:components) => components(),
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

Method: post
Path: /v1/account_sessions