Stripe.Resources.V2.Core.AccountLink (tiger_stripe v0.3.0)

Copy Markdown View Source

Account Link

Account Links let a platform create a temporary, single-use URL that an account can use to access a Stripe-hosted flow for collecting or updating required information.

Summary

Types

t()
use_case()
use_case_account_onboarding()
use_case_account_onboarding_collection_options()
use_case_account_update()
use_case_account_update_collection_options()

Functions

object_name()

Types

t()

@type t() :: %Stripe.Resources.V2.Core.AccountLink{
  account: String.t(),
  created: String.t(),
  expires_at: String.t(),
  livemode: boolean(),
  object: String.t(),
  url: String.t(),
  use_case: use_case()
}
  • account - The ID of the connected account this Account Link applies to.
  • created - The timestamp at which this Account Link was created. Format: date-time.
  • expires_at - The timestamp at which this Account Link will expire. Format: date-time.
  • 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 of the object field. Possible values: v2.core.account_link.
  • url - The URL at which the account can access the Stripe-hosted flow.
  • use_case - Hash containing usage options.

use_case()

@type use_case() :: %{
  optional(:account_onboarding) => use_case_account_onboarding() | nil,
  optional(:account_update) => use_case_account_update() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • account_onboarding - Hash containing configuration options for an Account Link object that onboards a new account.
  • account_update - Hash containing configuration options for an Account Link that updates an existing account.
  • type - Open Enum. The type of Account Link the user is requesting. Possible values: account_onboarding, account_update.

use_case_account_onboarding()

@type use_case_account_onboarding() :: %{
  optional(:collection_options) =>
    use_case_account_onboarding_collection_options() | nil,
  optional(:configurations) => [String.t()] | nil,
  optional(:refresh_url) => String.t() | nil,
  optional(:return_url) => String.t() | nil,
  optional(String.t()) => term()
}
  • collection_options - Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
  • configurations - Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.
  • refresh_url - The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
  • return_url - The URL that the user will be redirected to upon completing the linked flow.

use_case_account_onboarding_collection_options()

@type use_case_account_onboarding_collection_options() :: %{
  optional(:fields) => String.t() | nil,
  optional(:future_requirements) => String.t() | nil,
  optional(String.t()) => term()
}
  • fields - Specifies whether the platform collects only currently_due requirements (currently_due) or both currently_due and eventually_due requirements (eventually_due). If you don’t specify collection_options, the default value is currently_due. Possible values: currently_due, eventually_due.
  • future_requirements - Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is omit. Possible values: include, omit.

use_case_account_update()

@type use_case_account_update() :: %{
  optional(:collection_options) =>
    use_case_account_update_collection_options() | nil,
  optional(:configurations) => [String.t()] | nil,
  optional(:refresh_url) => String.t() | nil,
  optional(:return_url) => String.t() | nil,
  optional(String.t()) => term()
}
  • collection_options - Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.
  • configurations - Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
  • refresh_url - The URL the user will be redirected to if the Account Link is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new Account Link with the same parameters used to create the original Account Link, then redirect the user to the new Account Link URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user.
  • return_url - The URL that the user will be redirected to upon completing the linked flow.

use_case_account_update_collection_options()

@type use_case_account_update_collection_options() :: %{
  optional(:fields) => String.t() | nil,
  optional(:future_requirements) => String.t() | nil,
  optional(String.t()) => term()
}
  • fields - Specifies whether the platform collects only currently_due requirements (currently_due) or both currently_due and eventually_due requirements (eventually_due). The default value is currently_due. Possible values: currently_due, eventually_due.
  • future_requirements - Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is omit. Possible values: include, omit.

Functions

object_name()