Mayson Monorepo Documentation
    Preparing search index...

    Interface OAuthAuthorizeUrlParams

    interface OAuthAuthorizeUrlParams {
        client_id: string;
        response_type: "code";
        redirect_uri?: string;
        scope?: string;
        state?: string;
        stripe_landing?: string;
        always_prompt?: boolean;
        suggested_capabilities?: string[];
        stripe_user?: StripeUser;
    }
    Index

    Properties

    client_id: string

    The unique identifier provided to your application, found in your application settings.

    response_type: "code"

    The only option at the moment is 'code'.

    redirect_uri?: string

    The URL for the authorize response redirect. If provided, this must exactly match one of the comma-separated redirect_uri values in your application settings. To protect yourself from certain forms of man-in-the-middle attacks, the live mode redirect_uri must use a secure HTTPS connection. Defaults to the redirect_uri in your application settings if not provided.

    scope?: string

    read_write or read_only, depending on the level of access you need.

    Defaults to read_only.

    state?: string

    An arbitrary string value we will pass back to you, useful for CSRF protection.

    stripe_landing?: string

    login or register, depending on what type of screen you want your users to see. Only override this to be login if you expect all your users to have Stripe accounts already (e.g., most read-only applications, like analytics dashboards or accounting software). Defaults to login for scope read_only and register for scope read_write.

    always_prompt?: boolean

    Boolean to indicate that the user should always be asked to connect, even if they're already connected. Defaults to false.

    suggested_capabilities?: string[]

    Express only An array of capabilities to apply to the connected account.

    stripe_user?: StripeUser

    Stripe will use these to prefill details in the account form for new users. Some prefilled fields (e.g., URL or product category) may be automatically hidden from the user's view. Any parameters with invalid values will be silently ignored.