Stripe.Resources.FinancialConnections.Session (tiger_stripe v0.3.0)

Copy Markdown View Source

BankConnectionsResourceLinkAccountSession

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()
accounts()
filters()
t()

Functions

expandable_fields()
object_name()

Types

account_holder()

@type account_holder() :: %{
  optional(:account) => String.t() | Stripe.Resources.Account.t() | nil,
  optional(:customer) => String.t() | Stripe.Resources.Customer.t() | nil,
  optional(:customer_account) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • account - The ID of the Stripe account that this account belongs to. Only available when account_holder.type is account.
  • customer - The ID for an Account representing a customer that this account belongs to. Only available when account_holder.type is customer.
  • customer_account - Max length: 5000.
  • type - Type of account holder that this account belongs to. Possible values: account, customer.

accounts()

@type accounts() :: %{
  optional(:data) => [Stripe.Resources.FinancialConnections.Account.t()] | nil,
  optional(:has_more) => boolean() | nil,
  optional(:object) => String.t() | nil,
  optional(:url) => String.t() | nil,
  optional(String.t()) => term()
}
  • data - Details about each object.
  • has_more - True if this list has another page of items after this one that can be fetched.
  • object - String representing the object's type. Objects of the same type share the same value. Always has the value list. Possible values: list.
  • url - The URL where this list can be accessed. Max length: 5000.

filters()

@type filters() :: %{
  optional(:account_subcategories) => [String.t()] | nil,
  optional(:countries) => [String.t()] | nil,
  optional(String.t()) => term()
}
  • account_subcategories - Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: checking, savings, mortgage, line_of_credit, credit_card. Nullable.
  • countries - List of countries from which to filter accounts. Nullable.

t()

@type t() :: %Stripe.Resources.FinancialConnections.Session{
  account_holder: account_holder(),
  accounts: accounts(),
  client_secret: String.t(),
  filters: filters() | nil,
  id: String.t(),
  livemode: boolean(),
  object: String.t(),
  permissions: [String.t()],
  prefetch: [String.t()],
  return_url: String.t() | nil
}
  • account_holder - The account holder for whom accounts are collected in this session. Nullable. Expandable.
  • accounts - The accounts that were collected as part of this Session. Expandable.
  • client_secret - A value that will be passed to the client to launch the authentication flow. Max length: 5000. Nullable.
  • filters - Expandable.
  • id - Unique identifier for the object. Max length: 5000.
  • 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. Possible values: financial_connections.session.
  • permissions - Permissions requested for accounts collected during this session.
  • prefetch - Data features requested to be retrieved upon account creation. Nullable.
  • 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. Max length: 5000.

Functions

expandable_fields()

object_name()