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

    Class PaymentForm

    PaymentForm is a class that represents the payment form in the widget. It's data attribute holds the current state of the payment form and works as kind of a global state container. The payment request object is build based on this state - see epmsPaymentRequestData.

    Index

    Constructors

    constructor

    Properties

    allValidationErrors? data fieldsInSlots isCardFieldsShown registeredFields submitBlockers touchedFields

    Accessors

    allowCustomAmount allowedCardTypes directDebitData epmsPaymentRequestData eppPaymentRequestData eppSubscriptionRenewRequestData fieldToBlocksMapping flow isCoverFeeBlockShown isCvvSkipped isDisabled isEmailPermissionEnabled isEppCardIframeUsed isRequiredReferenceNumber isSecureExpFieldUsed isSecureFieldsHandlerDatatrans isSecureFieldsHandlerPaypal isSecureFieldsHandlerSpreedly isSecureFieldsUsed isSouthKoreanCard netbankingIssuerIds recurringIntervalsToRender requiredFields validationConstraints validationErrors

    Methods

    getAmount getCurrency getCustomAmount getFeeAmount getFeeFixed getFeePercentage getFeePercentageAdjusted getLastSelectedPaymentMethod getPaymentMethod getPaymentType getPossibleAmounts getPossibleCurrencies getPossiblePaymentMethods getPossiblePaymentTypes getPossiblePurposes getPossibleRecurringIntervals getPurpose getRecurringInterval getTotalAmount init isCustomAmount isPaymentMethodAllowed isPossibleAmount isPossibleCurrency isPossiblePaymentMethod isPossiblePaymentType isPossiblePurpose isPossibleRecurringInterval send setAmount setCurrency setCustomAmount setFieldRegistered setFieldTouched setInitialState setLastSelectedPaymentMethod setPaymentMethod setPaymentType setPurpose setRecurringInterval validate validateAndSend validateBeforeSend

    Constructors

    Properties

    allValidationErrors?: ValidationErrors
    data: PaymentFormData = {}
    fieldsInSlots: string[] = []
    isCardFieldsShown: boolean = false
    registeredFields: string[] = []
    submitBlockers: Set<string> = ...

    A set of class names that are used to block form submission. This is useful for preventing form submission until certain initializations are complete. For example, Stripe SDK, PayPal SDK, etc.

    touchedFields: string[] = []

    Accessors

    • get allowCustomAmount(): boolean

      Returns boolean

    • get directDebitData(): {
          bic: string;
          bicCountry: string
          | undefined;
          clearingNumber: string | undefined;
          directDebitVariant: DirectDebitVariant | undefined;
          iban: string;
          ibanCountry: string | undefined;
          isPostFinanceIban: boolean;
          isSepaIbanCountry: boolean;
          isSepaIbanCountryNonEea: boolean;
          isSwissIban: boolean;
      }

      Returns {
          bic: string;
          bicCountry: string | undefined;
          clearingNumber: string | undefined;
          directDebitVariant: DirectDebitVariant | undefined;
          iban: string;
          ibanCountry: string | undefined;
          isPostFinanceIban: boolean;
          isSepaIbanCountry: boolean;
          isSepaIbanCountryNonEea: boolean;
          isSwissIban: boolean;
      }

    • get isCoverFeeBlockShown(): boolean

      Note that this indicates if the "cover the fee" block is shown only, not if the user indicated they accept to actually cover the payment fees. This boolean is in stored_cover_transaction_fee.

      Returns boolean

    • get isCvvSkipped(): boolean

      Returns boolean

    • get isDisabled(): boolean

      Returns boolean

    • get isEmailPermissionEnabled(): boolean

      Returns boolean

    • get isEppCardIframeUsed(): boolean

      Returns boolean

    • get isRequiredReferenceNumber(): boolean

      Returns boolean

    • get isSecureExpFieldUsed(): boolean

      Returns boolean

    • get isSecureFieldsHandlerDatatrans(): boolean

      Returns boolean

    • get isSecureFieldsHandlerPaypal(): boolean

      Returns boolean

    • get isSecureFieldsHandlerSpreedly(): boolean

      Returns boolean

    • get isSecureFieldsUsed(): boolean

      Returns boolean

    • get isSouthKoreanCard(): boolean

      Returns boolean

    • get netbankingIssuerIds(): string[]

      Returns string[]

    • get requiredFields(): string[]

      Returns string[]

    Methods

    • Returns number | undefined

    • Returns string | undefined

    • Returns string | undefined

    • Returns the fee amount - the value which would be added to the payment when supporter chooses to cover transaction fees.

      Returns number

      value in currency units, e.g. 1.5 means 1.5 CHF

    • Returns the calculated fixed fee part. In case the legacy cover fee is used, it returns the legacy fixed fee. Otherwise, it returns the sum of processing, platform and organisation costs fixed fees.

      Returns number

      value in currency units, e.g. 1.5 means 1.5 CHF

    • Returns the calculated percentage fee part. In case the legacy cover fee is used, it returns the legacy percentage fee. Otherwise, it returns the sum of processing, platform and organisation costs percentage fees.

      Returns number

      value in percentage, e.g. 3.4 means 3.4%

    • Calculate adjusted percentage fee part, so that when supporter covers fees, the organisation receives the exact chosen amount after fees are deducted.

      Returns number

      value in percentage, e.g. 3.4 means 3.4%

    • Returns number[]

    • Returns string[]

    • Returns string[]

    • Returns string | undefined

    • Return the current amount to bill the user. This is based on the user's selected amount plus fees, when applied.

      Returns number | undefined

    • This method must be called only after parser helpers are registered

      Returns void

    • Parameters

      • Optionalamount: string | number

      Returns boolean

    • Parameters

      Returns any

    • Parameters

      • Optionalamount: number

      Returns boolean

    • Parameters

      • Optionalcurrency: string

      Returns boolean

    • Parameters

      • OptionalpaymentMethod: string

      Returns boolean

    • Parameters

      • OptionalpaymentType: string

      Returns boolean

    • Parameters

      • Optionalpurpose: string

      Returns boolean

    • Parameters

      • OptionalrecurringInterval: string

      Returns boolean

    • Returns Promise<void>

    • Parameters

      • Optionalamount: string | number
      • setCustomAmount: boolean = true

      Returns void

    • Parameters

      • Optionalcurrency: string

      Returns void

    • Parameters

      • OptionalcustomAmount: string

      Returns void

    • Parameters

      • name: string
      • isRegistered: boolean

      Returns void

    • Parameters

      • name: string
      • isTouched: boolean

      Returns void

    • Returns void

    • Parameters

      • Optionalpurpose: string

      Returns void

    • Returns Promise<void>

    • Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods