Type Alias Configuration

Configuration: {
    email?: string;
    merchantDisplayName: string;
    supportedPaymentMethodTypes?: LinkPaymentMethodType[];
    paymentMethodTypes?: string[];
    phoneNumber?: string;
    allowLogout?: boolean;
    billingDetailsCollectionConfiguration?: PaymentSheet.BillingDetailsCollectionConfiguration;
    appearance?: Onramp.LinkAppearance;
}

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.

  • OptionalpaymentMethodTypes?: string[]

    Payment method type strings to use when creating the SetupIntent. If omitted, types are chosen automatically.

  • 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.

  • OptionalbillingDetailsCollectionConfiguration?: PaymentSheet.BillingDetailsCollectionConfiguration

    Controls which billing fields are collected in the Link sheet.

  • Optionalappearance?: Onramp.LinkAppearance

    Customize the appearance of the Link UI.

Private Preview

Configuration for initializing the Link controller.

Settings

Member Visibility