Stripe.Resources.Terminal.OnboardingLink (tiger_stripe v0.3.0)

TerminalOnboardingLinkOnboardingLink

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

Summary

Types

link_options()

link_options_apple_terms_and_conditions()

t()

Functions

expandable_fields()

object_name()

Types

link_options()

@type link_options() :: %{
  optional(:apple_terms_and_conditions) =>
    link_options_apple_terms_and_conditions() | nil,
  optional(String.t()) => term()
}

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

link_options_apple_terms_and_conditions()

@type link_options_apple_terms_and_conditions() :: %{
  optional(:allow_relinking) => boolean() | nil,
  optional(:merchant_display_name) => String.t() | nil,
  optional(String.t()) => term()
}

allow_relinking - Whether the link should also support users relinking their Apple account. Nullable.
merchant_display_name - The business name of the merchant accepting Apple's Terms and Conditions. Max length: 5000.

t()

@type t() :: %Stripe.Resources.Terminal.OnboardingLink{
  link_options: link_options(),
  link_type: String.t(),
  object: String.t(),
  on_behalf_of: String.t(),
  redirect_url: String.t()
}

link_options - Expandable.
link_type - The type of link being generated. Possible values: apple_terms_and_conditions.
object - Possible values: terminal.onboarding_link.
on_behalf_of - Stripe account ID to generate the link for. Max length: 5000. Nullable.
redirect_url - The link passed back to the user for their onboarding. Max length: 5000.