Onboarding Links
Returns redirect links used for onboarding onto Tap to Pay on iPhone.
Was this section helpful? Yes No
Create an Onboarding Link
POST / v1 / terminal / onboarding_links
The Onboarding Link object
Attributes
- link _ options object Specific fields needed to generate the desired link type.
- link _ type enum The type of link being generated.
- on _ behalf _ of nullable string 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
Create an Onboarding Link
POST / v1 / terminal / onboarding_links
Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.
Parameters
- link _ options object Required Specific fields needed to generate the desired link type.
- link _ type enum Required The type of link being generated.
- on _ behalf _ of string Stripe account ID to generate the link for.
Returns
Returns an OnboardingLink object if creation succeeds.
Response