Mayson Monorepo Documentation
    Preparing search index...

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

    interface OnboardingLink {
        object: "terminal.onboarding_link";
        link_options: Stripe.Terminal.OnboardingLink.LinkOptions;
        link_type: "apple_terms_and_conditions";
        on_behalf_of: string;
        redirect_url: string;
    }
    Index

    Properties

    object: "terminal.onboarding_link"

    Link type options associated with the current onboarding link object.

    link_type: "apple_terms_and_conditions"

    The type of link being generated.

    on_behalf_of: string

    Stripe account ID to generate the link for.

    redirect_url: string

    The link passed back to the user for their onboarding.