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

Create an Onboarding Link 

Terminal
Onboarding Link
Create an Onboarding Link

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

Parameters

  • link_optionsobjectRequired

    Specific fields needed to generate the desired link type.

    • link_options.apple_terms_and_conditionsobject

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

      • link_options.apple_terms_and_conditions.merchant_display_namestringRequired

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

      • link_options.apple_terms_and_conditions.allow_relinkingboolean

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

  • link_typeenumRequired

    The type of link being generated.

  • on_behalf_ofstring

    Stripe account ID to generate the link for.

Returns

Returns an OnboardingLink object if creation succeeds.

POST /v1/terminal/onboarding_links
curl https://api.stripe.com/v1/terminal/onboarding_links \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -H "Stripe-Version: 2025-11-17.preview" \
  -d "link_options[apple_terms_and_conditions][allow_relinking]"=true \
  -d "link_options[apple_terms_and_conditions][merchant_display_name]"="My First Store" \
  -d link_type=apple_terms_and_conditions
Response
{
  "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"
}