The Onboarding Link object

Attributes

• link_options (object) Specific fields needed to generate the desired link type.

  • link_options.apple_terms_and_conditions (object, nullable) The options associated with the Apple Terms and Conditions link type.

    • link_options.apple_terms_and_conditions.allow_relinking (boolean, nullable) Whether the link should also support users relinking their Apple account.

    • link_options.apple_terms_and_conditions.merchant_display_name (string) The business name of the merchant accepting Apple’s Terms and Conditions.

• link_type (enum) The type of link being generated.

• on_behalf_of (string, nullable) Stripe account ID to generate the link for.

• redirect_url (string) The link passed back to the user for their onboarding.

The Onboarding Link object

{
  "object": "terminal.onboarding_link",
  "link_options": {
    "apple_terms_and_conditions": {
      "allow_relinking": true,
      "merchant_display_name": "My First Store"
    }
  },
  "link_type": "apple_terms_and_conditions",
  "redirect_url": "https://register.apple.com/tap-to-pay-on-iphone/merchantLandingPage"
}