@oneblink/apps-react
    Preparing search index...

    Function handlePaymentSubmissionEvent

    • Handle a submission result with a payment submission event. Will throw an error if a transaction has already been made using this submission result. Will return undefined if the submission does not have an amount. Will return the submission result passed in with a payment property if the submission requires processing.

      const formSubmissionResult = {
      submissionId: '89c6e98e-f56f-45fc-84fe-c4fc62331d34',
      submissionTimestamp: '2020-07-29T01:03:26.573Z'
      formsAppId: 1,
      submission: {
      form: 'data',
      goes: 'here',
      amount: 1.50,
      }
      definition: OneBlinkForm,
      payment: null,
      }
      const paymentSubmissionEvent = {
      type: 'CP_PAY',
      configuration: {
      elementId: '12663efc-4c6a-4e72-8505-559edfe3e92e',
      gatewayId: '6658c5c4-e0db-483b-8af7-6a6464fe772c',
      },
      }
      const paymentReceiptUrl = `${window.location.origin}/payment-receipt`
      const paymentSubmissionResult = await paymentService.handlePaymentSubmissionEvent({
      formSubmissionResult,
      paymentSubmissionEvent,
      paymentReceiptUrl,
      })
      if (paymentSubmissionResult) {
      window.location.href = paymentSubmissionResult.payment.hostedFormUrl
      }

      Parameters

      • options: {
            amount: number;
            formSubmissionResult: FormSubmissionResult;
            paymentFormUrl: string | undefined;
            paymentReceiptUrl: string;
            paymentSubmissionEvent: FormPaymentEvent;
        }

      Returns Promise<
          | {
              amount: number;
              hostedFormUrl: string;
              paymentFormUrl: string
              | undefined;
              paymentReceiptUrl: string;
              submissionEvent: FormPaymentEvent;
          }
          | null,
      >