Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Payment Records
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Onboarding Link object 

Terminal
Onboarding Link
The Onboarding Link object

Attributes

  • link_optionsobject

    Specific fields needed to generate the desired link type.

    • link_options.apple_terms_and_conditionsnullable object

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

      • link_options.apple_terms_and_conditions.allow_relinkingnullable boolean

        Whether the link should also support users relinking their Apple account.

      • link_options.apple_terms_and_conditions.merchant_display_namestring

        The business name of the merchant accepting Apple’s Terms and Conditions.

  • link_typeenum

    The type of link being generated.

  • on_behalf_ofnullable string

    Stripe account ID to generate the link for.

  • redirect_urlstring

    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"
}