View Source Stripe.AccountLink (stripity_stripe v3.2.0)

Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.

Related guide: Connect Onboarding

Summary

Types

t()

The account_link type.

Functions

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

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

Types

Link to this type

t()

View Source 
@type t() :: %Stripe.AccountLink{
  created: integer(),
  expires_at: integer(),
  object: binary(),
  url: binary()
}

The account_link type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • expires_at The timestamp at which this account link will expire.
  • object String representing the object's type. Objects of the same type share the same value.
  • url The URL for the account link.

Functions

Link to this function

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

View Source 
@spec create(
  params :: %{
    optional(:account) => binary(),
    optional(:collect) => :currently_due | :eventually_due,
    optional(:expand) => [binary()],
    optional(:refresh_url) => binary(),
    optional(:return_url) => binary(),
    optional(:type) => :account_onboarding | :account_update
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.

Details

  • Method: post
  • Path: /v1/account_links