Mayson Monorepo Documentation
    Preparing search index...

    A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

    interface Session {
        id: string;
        object: "financial_connections.session";
        account_holder: Stripe.FinancialConnections.Session.AccountHolder;
        accounts: ApiList<Stripe.FinancialConnections.Account>;
        client_secret: string;
        filters?: Stripe.FinancialConnections.Session.Filters;
        livemode: boolean;
        permissions: Stripe.FinancialConnections.Session.Permission[];
        prefetch: Stripe.FinancialConnections.Session.Prefetch[];
        return_url?: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "financial_connections.session"

    String representing the object's type. Objects of the same type share the same value.

    The account holder for whom accounts are collected in this session.

    The accounts that were collected as part of this Session.

    client_secret: string

    A value that will be passed to the client to launch the authentication flow.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    Permissions requested for accounts collected during this session.

    Data features requested to be retrieved upon account creation.

    return_url?: string

    For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.