@oneblink/sdk-core
    Preparing search index...

    Function checkForPaymentEvent

    • Examine a submission and its form definition to validate whether a payment workflow event needs to run.

      const result = paymentService.checkForPaymentEvent({
        definition: form,
        submission,
        submissionTimestamp,
        parseDayOnlyDate: (value) => new Date(`${value}T00:00:00.000Z`),
        addDaysToDate: (date, days) => {
          date.setUTCDate(date.getUTCDate() + days)
          return date
        },
        startOfDay: (date) => {
          date.setUTCHours(0, 0, 0, 0)
          return date
        },
        endOfDay: (date) => {
          date.setUTCHours(23, 59, 59, 999)
          return date
        },
      })

      Parameters

      • options: {
            addDaysToDate: AddOffsetToDate;
            definition: Form;
            endOfDay: EndOfDay;
            parseDayOnlyDate: ParseDayOnlyDate;
            startOfDay: StartOfDay;
            submission: { [name: string]: unknown };
            submissionTimestamp: string;
        }
        • addDaysToDate: AddOffsetToDate

          Add days to a date when evaluating date based predicates

        • definition: Form
        • endOfDay: EndOfDay

          End of calendar day when evaluating date (not datetime) based predicates

        • parseDayOnlyDate: ParseDayOnlyDate

          Parse YYYY-MM-DD strings when evaluating date based predicates

        • startOfDay: StartOfDay

          Start of calendar day when evaluating date (not datetime) based predicates

        • submission: { [name: string]: unknown }
        • submissionTimestamp: string

          ISO timestamp the form was submitted. When evaluating during submission, pass new Date().toISOString().

      Returns { amount: number; paymentSubmissionEvent: FormPaymentEvent } | undefined

    Settings

    Member Visibility

    On This Page

    Example