Create an Onboarding Link

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

post/v1/terminal/onboarding_links

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/terminal/onboarding_links
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Response

Successful response.

link_type'apple_terms_and_conditions' required

The type of link being generated.

object'terminal.onboarding_link' required
on_behalf_ofstring nullable

Stripe account ID to generate the link for.

redirect_urlstring required

The link passed back to the user for their onboarding.

Changes

No operation changes found yet. Some revisions have not been checked.