View Source Stripe.FinancialConnections.Session (stripity_stripe v3.2.0)

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Summary

Types

account_holder()

The account holder to link accounts for.

filters()

Filters to restrict the kinds of accounts to collect.

t()

The financial_connections.session type.

Functions

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

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.

retrieve(session, params \\ %{}, opts \\ [])

Retrieves the details of a Financial Connections Session

Types

account_holder()

@type account_holder() :: %{
  optional(:account) => binary(),
  optional(:customer) => binary(),
  optional(:type) => :account | :customer
}

The account holder to link accounts for.

filters()

@type filters() :: %{optional(:countries) => [binary()]}

Filters to restrict the kinds of accounts to collect.

t()

@type t() :: %Stripe.FinancialConnections.Session{
  account_holder: term() | nil,
  accounts: term(),
  client_secret: binary(),
  filters: term(),
  id: binary(),
  livemode: boolean(),
  object: binary(),
  permissions: term(),
  prefetch: term() | nil,
  return_url: binary()
}

The financial_connections.session type.

account_holder The account holder for whom accounts are collected in this session.
accounts The accounts that were collected as part of this Session.
client_secret A value that will be passed to the client to launch the authentication flow.
filters
id Unique identifier for the object.
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.
permissions Permissions requested for accounts collected during this session.
prefetch Data features requested to be retrieved upon account creation.
return_url 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.

Functions

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

@spec create(
  params :: %{
    optional(:account_holder) => account_holder(),
    optional(:expand) => [binary()],
    optional(:filters) => filters(),
    optional(:permissions) => [
      :balances | :ownership | :payment_method | :transactions
    ],
    optional(:prefetch) => [:balances | :ownership | :transactions],
    optional(:return_url) => binary()
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

Method: post
Path: /v1/financial_connections/sessions

retrieve(session, params \\ %{}, opts \\ [])

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

Retrieves the details of a Financial Connections Session

Details

Method: get
Path: /v1/financial_connections/sessions/{session}