@raisenow/tamaro-core
    Preparing search index...

    Type Alias WidgetConfig

    Represents the configurations read from the widget's yaml file. Note that values are not parsed yet and have to be computed before they can be used, e.g. you cannot access something like:

    const account = config.epms.live.accountUuid

    but this needs to be computed with a function:

    const account = config.epmsConfig.accountUuid
    type WidgetConfig = {
        abTestVariants: string[];
        allowCustomAmount: boolean | ConfigCondition<boolean>[];
        allowedCardTypes?: ConfigCondition<CardType>[];
        allowedRecurringPaymentMethods: ConfigCondition<RecurringPaymentMethod>[];
        allowSwissQrBillOrder: boolean | ConfigCondition<boolean>[];
        amounts: ConfigCondition<number>[];
        analyticsEventTracking: boolean | ConfigCondition<boolean>[];
        autogeneratedDonationReceiptEnabled: boolean;
        autoselectAmount: boolean;
        autoselectPaymentMethod: boolean;
        autoselectPaymentType: boolean;
        autoselectPurpose: boolean;
        blocksOrder: BlockName[];
        countries: ConfigCondition<string>[];
        coverFeeAdjustmentEnabled?: boolean | ConfigCondition<boolean>[];
        coverFeeFixed?: ConfigCondition<number>[] | number;
        coverFeeForced?: boolean | ConfigCondition<boolean>[];
        coverFeeOrganisationCostsFixed?: ConfigCondition<number>[] | number;
        coverFeeOrganisationCostsPercentage?: ConfigCondition<number>[] | number;
        coverFeePercentage?: ConfigCondition<number>[] | number;
        coverFeePlatformFixed?: ConfigCondition<number>[] | number;
        coverFeePlatformPercentage?: ConfigCondition<number>[] | number;
        coverFeeProcessingFixed?: ConfigCondition<number>[] | number;
        coverFeeProcessingPercentage?: ConfigCondition<number>[] | number;
        currencies: ConfigCondition<string>[];
        customCssUrl?: string;
        dateDisplayFormat: string;
        dateStoreFormat: string;
        ddFormTemplate?: ConfigCondition<string>[] | string;
        debug: boolean;
        debugErrorMessages: boolean;
        debugSlots: boolean;
        defaultAmount?: number;
        defaultCurrency?: string;
        defaultPaymentMethod?: PaymentMethod;
        defaultPaymentType?: PaymentType;
        defaultPurpose?: string;
        defaultRecurringInterval?: RecurringInterval;
        demoMode: boolean | ConfigCondition<boolean>[];
        donationReceiptRequiresFields: boolean;
        epikConfig?: LegacyEpikConfig;
        epms: EpmsConfig;
        epmsEnv: EpmsEnv;
        epmsStage: EpmsConfig;
        epp: EppConfig;
        eppEnv: EppEnv;
        eppStage: EppConfig;
        errorLogging: boolean;
        expandedFaqEntries: ConfigCondition<string>[];
        fallbackLanguage: false | string;
        faqEntries: ConfigCondition<string>[];
        fetchPaymentDataOnQueryParamsChange: boolean;
        flow: ConfigCondition<PaymentFlow>[] | PaymentFlow;
        forcePaymentValidations: ValidationConstraints;
        forceShowBlocks: Partial<ShowBlocksConfig>;
        forceShowFields: Partial<ShowFieldsConfig>;
        highlightRecurring: boolean | ConfigCondition<boolean>[];
        immediateExecution?: boolean | ConfigCondition<boolean>[];
        language: string;
        maximumCustomAmount?: ConfigCondition<number>[] | number;
        minimumCustomAmount: ConfigCondition<number>[] | number;
        netbankingIssuerIds: ConfigCondition<string>[];
        oneClickPayment: boolean | ConfigCondition<boolean>[];
        onlySubmitVisibleStandardFields: boolean;
        organisationCountryCode?: string;
        paymentFormDataCache: boolean;
        paymentFormPrefill: PaymentFormData;
        paymentMethods: ConfigCondition<PaymentMethod>[];
        paymentProvider: PaymentProvider;
        paymentStatusPollInterval: number;
        paymentTypes: ConfigCondition<PaymentType>[];
        paymentValidations: ValidationConstraints;
        paymentWidgetBlocks: ConfigCondition<BlockName>[];
        pgwProxyIframeUrl: ConfigCondition<string>[] | string;
        priorityCardTypes: ConfigCondition<CardType>[];
        priorityCountries: ConfigCondition<string>[];
        priorityCreditCardTypes?: ConfigCondition<CardType>[];
        progressBarEnabled: boolean;
        purposeDetails: PurposeDetailsConfig;
        purposes: ConfigCondition<string>[];
        recaptchaKey?: string;
        recurringIntervals: ConfigCondition<RecurringInterval>[];
        recurringIntervalsLayout:
            | ConfigCondition<RecurringIntervalLayout>[]
            | RecurringIntervalLayout;
        redirectToCustomResultPage?: (api: WidgetApi) => Promise<void> | void;
        requireSwissQrBillReferenceNumber: boolean | ConfigCondition<boolean>[];
        salutations: ConfigCondition<string>[];
        showBic?: boolean | ConfigCondition<boolean>[];
        showBlockHeaders: Partial<ShowBlocksConfig>;
        showBlocks: Partial<ShowBlocksConfig>;
        showFields: Partial<ShowFieldsConfig>;
        showFooter: boolean | ConfigCondition<boolean>[];
        showPaymentInfo: boolean | ConfigCondition<boolean>[];
        showRetryPaymentButton: boolean | ConfigCondition<boolean>[];
        showStoredCustomerBirthdate?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerCity?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerCountry?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerDonationReceipt?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerEmail?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerEmailPermission?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerFirstname?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerLastname?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerMessage?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerPobox?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerRawAddress?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerRawName?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerSalutation?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerState?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerStreet?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerStreet2?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerStreetNumber?: boolean | ConfigCondition<boolean>[];
        showStoredCustomerZipCode?: boolean | ConfigCondition<boolean>[];
        showSubmitButton: boolean | ConfigCondition<boolean>[];
        showTestModeBar: boolean | ConfigCondition<boolean>[];
        showValidationAlert: boolean | ConfigCondition<boolean>[];
        skipCvv: boolean | ConfigCondition<boolean>[];
        slots: SlotsConfig;
        states: Record<string, string[]>;
        stripeAccount?: string;
        subscriptionStatusPollInterval: number;
        taxIdLocale: ConfigCondition<string>[] | string;
        testMode: boolean;
        translations?: { [lang: string]: any };
        twintCheckoutUrlParams?: Record<string, string>;
        uiBreakpoints: UiBreakpointsConfig;
        uiCheckboxRadius: number;
        uiCustomCheckableElements: boolean;
        uiFloatingLabels: boolean;
        uiHeadingLevel: number;
        uiInvalidElementsScope?: string;
        uiRippleEffects: boolean;
        uiScrollOffsetBottom: number;
        uiScrollOffsetTop: number;
        uiTransitionTimeout: number;
        updateFormDataOnRetryPayment?: boolean | ConfigCondition<boolean>[];
    }
    Index

    Properties

    abTestVariants allowCustomAmount allowedCardTypes? allowedRecurringPaymentMethods allowSwissQrBillOrder amounts analyticsEventTracking autogeneratedDonationReceiptEnabled autoselectAmount autoselectPaymentMethod autoselectPaymentType autoselectPurpose blocksOrder countries coverFeeAdjustmentEnabled? coverFeeFixed? coverFeeForced? coverFeeOrganisationCostsFixed? coverFeeOrganisationCostsPercentage? coverFeePercentage? coverFeePlatformFixed? coverFeePlatformPercentage? coverFeeProcessingFixed? coverFeeProcessingPercentage? currencies customCssUrl? dateDisplayFormat dateStoreFormat ddFormTemplate? debug debugErrorMessages debugSlots defaultAmount? defaultCurrency? defaultPaymentMethod? defaultPaymentType? defaultPurpose? defaultRecurringInterval? demoMode donationReceiptRequiresFields epikConfig? epms epmsEnv epmsStage epp eppEnv eppStage errorLogging expandedFaqEntries fallbackLanguage faqEntries fetchPaymentDataOnQueryParamsChange flow forcePaymentValidations forceShowBlocks forceShowFields highlightRecurring immediateExecution? language maximumCustomAmount? minimumCustomAmount netbankingIssuerIds oneClickPayment onlySubmitVisibleStandardFields organisationCountryCode? paymentFormDataCache paymentFormPrefill paymentMethods paymentProvider paymentStatusPollInterval paymentTypes paymentValidations paymentWidgetBlocks pgwProxyIframeUrl priorityCardTypes priorityCountries priorityCreditCardTypes? progressBarEnabled purposeDetails purposes recaptchaKey? recurringIntervals recurringIntervalsLayout redirectToCustomResultPage? requireSwissQrBillReferenceNumber salutations showBic? showBlockHeaders showBlocks showFields showFooter showPaymentInfo showRetryPaymentButton showStoredCustomerBirthdate? showStoredCustomerCity? showStoredCustomerCountry? showStoredCustomerDonationReceipt? showStoredCustomerEmail? showStoredCustomerEmailPermission? showStoredCustomerFirstname? showStoredCustomerLastname? showStoredCustomerMessage? showStoredCustomerPobox? showStoredCustomerRawAddress? showStoredCustomerRawName? showStoredCustomerSalutation? showStoredCustomerState? showStoredCustomerStreet? showStoredCustomerStreet2? showStoredCustomerStreetNumber? showStoredCustomerZipCode? showSubmitButton showTestModeBar showValidationAlert skipCvv slots states stripeAccount? subscriptionStatusPollInterval taxIdLocale testMode translations? twintCheckoutUrlParams? uiBreakpoints uiCheckboxRadius uiCustomCheckableElements uiFloatingLabels uiHeadingLevel uiInvalidElementsScope? uiRippleEffects uiScrollOffsetBottom uiScrollOffsetTop uiTransitionTimeout updateFormDataOnRetryPayment?

    Properties

    abTestVariants: string[]
    allowCustomAmount: boolean | ConfigCondition<boolean>[]
    allowedCardTypes?: ConfigCondition<CardType>[]
    allowedRecurringPaymentMethods: ConfigCondition<RecurringPaymentMethod>[]
    allowSwissQrBillOrder: boolean | ConfigCondition<boolean>[]
    amounts: ConfigCondition<number>[]
    analyticsEventTracking: boolean | ConfigCondition<boolean>[]
    autogeneratedDonationReceiptEnabled: boolean
    autoselectAmount: boolean
    autoselectPaymentMethod: boolean
    autoselectPaymentType: boolean
    autoselectPurpose: boolean
    blocksOrder: BlockName[]
    countries: ConfigCondition<string>[]
    coverFeeAdjustmentEnabled?: boolean | ConfigCondition<boolean>[]
    coverFeeFixed?: ConfigCondition<number>[] | number
    coverFeeForced?: boolean | ConfigCondition<boolean>[]

    https://raisenow.atlassian.net/browse/WEB-3289

    coverFeeOrganisationCostsFixed?: ConfigCondition<number>[] | number
    coverFeeOrganisationCostsPercentage?: ConfigCondition<number>[] | number
    coverFeePercentage?: ConfigCondition<number>[] | number
    coverFeePlatformFixed?: ConfigCondition<number>[] | number
    coverFeePlatformPercentage?: ConfigCondition<number>[] | number
    coverFeeProcessingFixed?: ConfigCondition<number>[] | number
    coverFeeProcessingPercentage?: ConfigCondition<number>[] | number
    currencies: ConfigCondition<string>[]
    customCssUrl?: string
    dateDisplayFormat: string
    dateStoreFormat: string
    ddFormTemplate?: ConfigCondition<string>[] | string
    debug: boolean
    debugErrorMessages: boolean
    debugSlots: boolean
    defaultAmount?: number

    Use "paymentFormPrefill.amount" instead

    defaultCurrency?: string

    Use "paymentFormPrefill.currency" instead

    defaultPaymentMethod?: PaymentMethod

    Use "paymentFormPrefill.payment_method" instead

    defaultPaymentType?: PaymentType

    Use "paymentFormPrefill.payment_type" instead

    defaultPurpose?: string

    Use "paymentFormPrefill.purpose" instead

    defaultRecurringInterval?: RecurringInterval

    Use "paymentFormPrefill.recurring_interval" instead

    demoMode: boolean | ConfigCondition<boolean>[]
    donationReceiptRequiresFields: boolean
    epikConfig?: LegacyEpikConfig
    epms: EpmsConfig
    epmsEnv: EpmsEnv
    epmsStage: EpmsConfig
    epp: EppConfig
    eppEnv: EppEnv
    eppStage: EppConfig
    errorLogging: boolean
    expandedFaqEntries: ConfigCondition<string>[]
    fallbackLanguage: false | string
    faqEntries: ConfigCondition<string>[]
    fetchPaymentDataOnQueryParamsChange: boolean
    flow: ConfigCondition<PaymentFlow>[] | PaymentFlow
    forcePaymentValidations: ValidationConstraints
    forceShowBlocks: Partial<ShowBlocksConfig>
    forceShowFields: Partial<ShowFieldsConfig>
    highlightRecurring: boolean | ConfigCondition<boolean>[]
    immediateExecution?: boolean | ConfigCondition<boolean>[]

    Moved to "epp.immediateExecution" or "eppStage.immediateExecution"

    language: string
    maximumCustomAmount?: ConfigCondition<number>[] | number
    minimumCustomAmount: ConfigCondition<number>[] | number
    netbankingIssuerIds: ConfigCondition<string>[]
    oneClickPayment: boolean | ConfigCondition<boolean>[]
    onlySubmitVisibleStandardFields: boolean
    organisationCountryCode?: string
    paymentFormDataCache: boolean
    paymentFormPrefill: PaymentFormData
    paymentMethods: ConfigCondition<PaymentMethod>[]
    paymentProvider: PaymentProvider
    paymentStatusPollInterval: number
    paymentTypes: ConfigCondition<PaymentType>[]
    paymentValidations: ValidationConstraints
    paymentWidgetBlocks: ConfigCondition<BlockName>[]

    Use showBlocks.{block_name} instead

    pgwProxyIframeUrl: ConfigCondition<string>[] | string
    priorityCardTypes: ConfigCondition<CardType>[]
    priorityCountries: ConfigCondition<string>[]
    priorityCreditCardTypes?: ConfigCondition<CardType>[]

    Use "priorityCardTypes" instead

    progressBarEnabled: boolean
    purposeDetails: PurposeDetailsConfig
    purposes: ConfigCondition<string>[]
    recaptchaKey?: string
    recurringIntervals: ConfigCondition<RecurringInterval>[]
    recurringIntervalsLayout:
        | ConfigCondition<RecurringIntervalLayout>[]
        | RecurringIntervalLayout
    redirectToCustomResultPage?: (api: WidgetApi) => Promise<void> | void
    requireSwissQrBillReferenceNumber: boolean | ConfigCondition<boolean>[]
    salutations: ConfigCondition<string>[]
    showBic?: boolean | ConfigCondition<boolean>[]

    Use "showFields.bic" instead

    showBlockHeaders: Partial<ShowBlocksConfig>
    showBlocks: Partial<ShowBlocksConfig>
    showFields: Partial<ShowFieldsConfig>
    showFooter: boolean | ConfigCondition<boolean>[]
    showPaymentInfo: boolean | ConfigCondition<boolean>[]
    showRetryPaymentButton: boolean | ConfigCondition<boolean>[]
    showStoredCustomerBirthdate?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_birthdate" instead

    showStoredCustomerCity?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_city" instead

    showStoredCustomerCountry?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_country" instead

    showStoredCustomerDonationReceipt?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_donation_receipt" instead

    showStoredCustomerEmail?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_email" instead

    showStoredCustomerEmailPermission?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_email_permission" instead

    showStoredCustomerFirstname?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_firstname" instead

    showStoredCustomerLastname?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_lastname" instead

    showStoredCustomerMessage?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_message" instead

    showStoredCustomerPobox?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_pobox" instead

    showStoredCustomerRawAddress?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_raw_address" instead

    showStoredCustomerRawName?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_raw_name" instead

    showStoredCustomerSalutation?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_salutation" instead

    showStoredCustomerState?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_state" instead

    showStoredCustomerStreet?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_street" instead

    showStoredCustomerStreet2?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_street2" instead

    showStoredCustomerStreetNumber?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_street_number" instead

    showStoredCustomerZipCode?: boolean | ConfigCondition<boolean>[]

    Use "showFields.stored_customer_zip_code" instead

    showSubmitButton: boolean | ConfigCondition<boolean>[]
    showTestModeBar: boolean | ConfigCondition<boolean>[]
    showValidationAlert: boolean | ConfigCondition<boolean>[]
    skipCvv: boolean | ConfigCondition<boolean>[]
    slots: SlotsConfig
    states: Record<string, string[]>
    stripeAccount?: string

    Moved to "epms.stripeAccount" or "epmsStage.stripeAccount"

    subscriptionStatusPollInterval: number
    taxIdLocale: ConfigCondition<string>[] | string
    testMode: boolean
    translations?: { [lang: string]: any }
    twintCheckoutUrlParams?: Record<string, string>
    uiBreakpoints: UiBreakpointsConfig
    uiCheckboxRadius: number
    uiCustomCheckableElements: boolean
    uiFloatingLabels: boolean
    uiHeadingLevel: number
    uiInvalidElementsScope?: string
    uiRippleEffects: boolean
    uiScrollOffsetBottom: number
    uiScrollOffsetTop: number
    uiTransitionTimeout: number
    updateFormDataOnRetryPayment?: boolean | ConfigCondition<boolean>[]

    Settings

    Member Visibility

    On This Page

    Properties
    abTestVariantsallowCustomAmountallowedCardTypesallowedRecurringPaymentMethodsallowSwissQrBillOrderamountsanalyticsEventTrackingautogeneratedDonationReceiptEnabledautoselectAmountautoselectPaymentMethodautoselectPaymentTypeautoselectPurposeblocksOrdercountriescoverFeeAdjustmentEnabledcoverFeeFixedcoverFeeForcedcoverFeeOrganisationCostsFixedcoverFeeOrganisationCostsPercentagecoverFeePercentagecoverFeePlatformFixedcoverFeePlatformPercentagecoverFeeProcessingFixedcoverFeeProcessingPercentagecurrenciescustomCssUrldateDisplayFormatdateStoreFormatddFormTemplatedebugdebugErrorMessagesdebugSlotsdefaultAmountdefaultCurrencydefaultPaymentMethoddefaultPaymentTypedefaultPurposedefaultRecurringIntervaldemoModedonationReceiptRequiresFieldsepikConfigepmsepmsEnvepmsStageeppeppEnveppStageerrorLoggingexpandedFaqEntriesfallbackLanguagefaqEntriesfetchPaymentDataOnQueryParamsChangeflowforcePaymentValidationsforceShowBlocksforceShowFieldshighlightRecurringimmediateExecutionlanguagemaximumCustomAmountminimumCustomAmountnetbankingIssuerIdsoneClickPaymentonlySubmitVisibleStandardFieldsorganisationCountryCodepaymentFormDataCachepaymentFormPrefillpaymentMethodspaymentProviderpaymentStatusPollIntervalpaymentTypespaymentValidationspaymentWidgetBlockspgwProxyIframeUrlpriorityCardTypespriorityCountriespriorityCreditCardTypesprogressBarEnabledpurposeDetailspurposesrecaptchaKeyrecurringIntervalsrecurringIntervalsLayoutredirectToCustomResultPagerequireSwissQrBillReferenceNumbersalutationsshowBicshowBlockHeadersshowBlocksshowFieldsshowFootershowPaymentInfoshowRetryPaymentButtonshowStoredCustomerBirthdateshowStoredCustomerCityshowStoredCustomerCountryshowStoredCustomerDonationReceiptshowStoredCustomerEmailshowStoredCustomerEmailPermissionshowStoredCustomerFirstnameshowStoredCustomerLastnameshowStoredCustomerMessageshowStoredCustomerPoboxshowStoredCustomerRawAddressshowStoredCustomerRawNameshowStoredCustomerSalutationshowStoredCustomerStateshowStoredCustomerStreetshowStoredCustomerStreet2showStoredCustomerStreetNumbershowStoredCustomerZipCodeshowSubmitButtonshowTestModeBarshowValidationAlertskipCvvslotsstatesstripeAccountsubscriptionStatusPollIntervaltaxIdLocaletestModetranslationstwintCheckoutUrlParamsuiBreakpointsuiCheckboxRadiusuiCustomCheckableElementsuiFloatingLabelsuiHeadingLeveluiInvalidElementsScopeuiRippleEffectsuiScrollOffsetBottomuiScrollOffsetTopuiTransitionTimeoutupdateFormDataOnRetryPayment