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

Onboarding Link 

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

Endpoints

The Onboarding Link object 

Attributes

  • link_optionsobject

    Specific fields needed to generate the desired link type.

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

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_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-07-30.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"
}

Financial Accounts 

Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs.

Endpoints

Financial Account Features 

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

Endpoints