Managing Your Works With Stripe Listing

    Stripe Verified Partners can learn how to update their listing in the Works With Stripe gallery.

    Your Works With Stripe listing information is shown in the Works With Stripe gallery and also used in the Dashboard when we show recommended integrations as part of new user onboarding.

    You can add or update the following listing information at any time in the Works With section of the Dashboard.

    Field Description
    Learn more URL A link to a page where customers can learn more about your company or integration. If possible, this should be a page specifically about using Stripe with your integration. This link is required and used as a fallback for the more specific links listed below.
    Create Account URL optional A link to your registration page. We’ll send users here if they want to create a new account on your platform.
    Sign-in URL optional A link to your sign in page. We’ll send users here if they want to sign-in to an existing account on your platform.
    How to Link URL optional A link to documentation explaining how to connect an account on your platform to Stripe. This is shown to users interested in connecting an existing Stripe account with your integration. If you do not have this type of documentation, please fill in the Learn more URL instead.
    Connect to Stripe URL optional A link to your implementation of the Connect to Stripe URL. See details below. If you cannot implement this URL at this time, please fill in a How to Link URL, which will be used instead.

    Implementing the Connect to Stripe URL

    We show a listing of Stripe Verified Partners as part the onboarding flow for new users. Users are presented with three steps:

    1. Choose an app integration from a list of Stripe Verified Partners
    2. Sign in or create an account (using the URLs you provided)
    3. Connect their Stripe account to your platform

    The Connect to Stripe URL is used in the last step. When the user clicks this link, your integration should initiate a Stripe Connect OAuth flow with the appropriate parameters set.

    There are two methods for implementing the Connect to Stripe URL:

    • If you already have a settings page which allows signed-in users to connect to Stripe, you may link to that page. As part of the flow, we ask users to sign in before clicking the Connect to Stripe URL.
    • To provide a truly seamless experience, we recommend that you implement a new endpoint that performs an HTTP redirect back to the Stripe Connect OAuth flow. You can likely reuse the Connect OAuth link parameters from your existing Stripe integration.

    Be sure to consider the following considerations as you implement this URL:

    • If the user is not logged in to your application: We ask users to sign-up or sign-in before linking their account. If that user is not signed-in when they follow your Connect to Stripe URL, redirect them to your Create Account URL.
    • If the user is logged in to your application: Redirect the user to the Stripe Connect OAuth flow with the appropriate parameters set.
    • If the user is logged in and has already completed the Connect OAuth flow: Redirect the user to the Stripe Connect OAuth flow with the appropriate parameters set without passing in always_prompt=true. This makes it obvious to the user that they have already completed the Connect OAuth flow.

    Questions?

    We're always happy to help with code or other questions you might have. Search our documentation, contact support, or connect with our sales team. You can also chat live with other developers in #stripe on freenode.

    Was this page helpful? Yes No

    Send

    Thank you for helping improve Stripe's documentation. If you need help or have any questions, please consider contacting support.

    On this page