Type Alias Configuration

Configuration: {
    email?: string;
    merchantDisplayName: string;
    supportedPaymentMethodTypes?: LinkPaymentMethodType[];
    phoneNumber?: string;
    allowLogout?: boolean;
    setupIntentClientSecret?: string;
}

Type declaration

  • Optionalemail?: string

    The customer's email address used for Link consumer lookup.

  • merchantDisplayName: string

    Your customer-facing business name, displayed in Link UI.

  • OptionalsupportedPaymentMethodTypes?: LinkPaymentMethodType[]

    Payment method types to support in the Link sheet. If omitted, all available types are shown.

  • OptionalphoneNumber?: string

    Customer phone number in E.164 format to prefill during signup.

  • OptionalallowLogout?: boolean

    Whether to allow the user to log out. Defaults to true.

  • OptionalsetupIntentClientSecret?: string

    Optional SetupIntent client secret. When provided, the SDK confirms the SetupIntent with the selected payment method automatically before returning.

Private Preview

Configuration for initializing the Link controller.

Settings

Member Visibility