Type Alias SaleWidgetParams

SaleWidgetParams: {
    environmentId?: string;
    items?: SaleItem[];
    collectionName?: string;
    walletProviderName?: WalletProviderName;
    language?: WidgetLanguage;
    excludePaymentTypes?: SalePaymentTypes[];
    excludeFiatCurrencies?: string[];
    preferredCurrency?: string;
    customOrderData?: Record<string, unknown>;
}

Sale Widget parameters

Type declaration

  • OptionalenvironmentId?: string

    Environment id from Immutable Hub

  • Optionalitems?: SaleItem[]

    The list of products to be purchased

  • OptionalcollectionName?: string

    The name of the NFT collection on sale

  • OptionalwalletProviderName?: WalletProviderName

    The wallet provider name to default to if no web3Provider is passed

  • Optionallanguage?: WidgetLanguage

    The language to use for the sales widget

  • OptionalexcludePaymentTypes?: SalePaymentTypes[]

    The disabled payment types

  • OptionalexcludeFiatCurrencies?: string[]

    Fiat currencies excluded from on-ramp

  • OptionalpreferredCurrency?: string

    Preferred currency, replacing the backend's base currency

  • OptionalcustomOrderData?: Record<string, unknown>

    Custom key-value pairs to be passed to the order

Settings

Member Visibility