Mayson Monorepo Documentation
    Preparing search index...

    Interface AccountOnboarding

    interface AccountOnboarding {
        collection_options?: Stripe.V2.Core.AccountLink.UseCase.AccountOnboarding.CollectionOptions;
        configurations: Stripe.V2.Core.AccountLink.UseCase.AccountOnboarding.Configuration[];
        refresh_url: string;
        return_url?: string;
    }
    Index

    Properties

    collection_options? configurations refresh_url return_url?

    Properties

    collection_options?: Stripe.V2.Core.AccountLink.UseCase.AccountOnboarding.CollectionOptions

    Specifies the requirements that Stripe collects from v2/core/accounts in the Onboarding flow.

    configurations: Stripe.V2.Core.AccountLink.UseCase.AccountOnboarding.Configuration[]

    Open Enum. A v2/core/account can be configured to enable certain functionality. The configuration param targets the v2/core/account_link to collect information for the specified v2/core/account configuration/s.

    refresh_url: string

    The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink's URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.

    return_url?: string

    The URL that the user will be redirected to upon completing the linked flow.

    Settings

    Member Visibility

    On This Page

    Properties