View Source Stripe.Terminal.OnboardingLink (stripity_stripe v3.3.1)

Returns redirect links used for onboarding onto Tap to Pay on iPhone.

Summary

Types

apple_terms_and_conditions()

The options associated with the Apple Terms and Conditions link type.

link_options()

Specific fields needed to generate the desired link type.

t()

The terminal.onboarding_link type.

Functions

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

Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.

Types

apple_terms_and_conditions()

@type apple_terms_and_conditions() :: %{
  optional(:allow_relinking) => boolean(),
  optional(:merchant_display_name) => binary()
}

The options associated with the Apple Terms and Conditions link type.

link_options()

@type link_options() :: %{
  optional(:apple_terms_and_conditions) => apple_terms_and_conditions()
}

Specific fields needed to generate the desired link type.

t()

@type t() :: %Stripe.Terminal.OnboardingLink{
  link_options: term(),
  link_type: binary(),
  object: binary(),
  on_behalf_of: binary() | nil,
  redirect_url: binary()
}

The terminal.onboarding_link type.

link_options
link_type The type of link being generated.
object
on_behalf_of Stripe account ID to generate the link for.
redirect_url The link passed back to the user for their onboarding.

Functions

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

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

Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.

Details

Method: post
Path: /v1/terminal/onboarding_links