Payment Form Widget
  • 22 Jan 2024
  • 3 minute read
  • Dark
    Light
  • PDF

Payment Form Widget

  • Dark
    Light
  • PDF

Article Summary

Use the payment form widget on a form to:

  • Calculate payment-due amounts and create Payment Due interactions on the user’s timeline .

  • Collect payments using Slate Payments as part of a form submission.

Payment widgets can be used on forms with these scopes:

  • person

  • application

  • dataset

Adding the payment widget

When you’re building the form that contains this widget, make sure that relevant form fields are mapped to their correct system fields. That way, the relevant record can be created or matched when the form is submitted and the resulting payment activity/interaction and payment record can be properly connected.

  1. From the main navigation, select Forms.

  2. Click New Form, or select an existing form.

  3. Configure form settings as needed.

  4. From the form palette at right, select the Payment Form widget. A popup appears.

  5. Configure the following settings:

    • Label: Enter a descriptive label for the widget.

    • Payment Amount: Select Sum of Payment Amounts, or Amount/Formula and enter the amount or formula to be calculated.

    • Payment Account: Select the payment account to be associated with the payment activity/interaction.

    • Embed Payment Form: Embed the payment collection on the form (for Slate Payments only), or only Calculate Payment Due amount.

      • If you are using the payment widget, it will automatically add a Payment Due activity or interaction (depending on scope) when the form is submitted. This can replace the use of a separate rule to add the payment due. If a payment rule is already on an existing form, it should be removed or inactivated.

      • If the payment collection is embedded on the form, the widget will use the Slate Payment configuration (deposit account, mode, options etc.) that has been set up in the Application Editor for the selected payment account (as described in Step 3 of the Setting up Slate Payments guide).

    • Create New Payment Due for Each Submission: Select this option if it is possible that the same user will submit this form multiple times at different points in time (for example, a giving form). 

    • Internal Only: Choose this option if the payment widget should be loaded only for internal form registrations.

  6. Click Save.

Note

Payment widgets should be extensively tested on all forms before the form is made live.

Calculate payment-due amount

You can calculate the payment due by leveraging fields on the form. The accompanying screenshot demonstrates a cost for the registrant, plus a cost for guests multiplied by the number of guests; this calculation determines the total amount due. The payment amount calculation works the same as any calculation formula in a form field.

Read more: Calculated fields

sample.png
Sample payment form using the Payment Form Widget

If the payment amount is fixed, just add a number. In this example, just the number itself—no dollar sign or other text required.

When using the widget to calculate the payment amount but not to collect the payment, a Payment Due activity or interaction will be created. For application-scoped payments, a link to make the payment will be visible on the applicant status page, assuming the 'Show Payment Due Link' setting is set, or on their custom status portal, assuming the Payments portal widget is added to the view.

For person-scoped payments, a form communication containing the merge field of Form-Payment must be created. This will direct registrants to the payment landing page. The Form-Payment merge field is only used when the payment is not collected directly through Slate Payments. 

Troubleshooting the payment form widget

null
Scope types that cannot be used with the Payment Form Widget
  • Prohibited Scopes: You cannot use the payment form widget on forms built on any of the Page Construction or Page Construction Widgets scopes.

  • Only one widget: Don’t create more than one payment widget that collects payments per form.

  • No additional form rules needed: The payment widget will automatically add a Payment Due activity or interaction to the record. Because of this, there should not be any additional rules on the form that add another Payment Due item (for the same payment_account prompt value). If an existing form that previously used rules to add a Payment Due is being updated, remember to inactivate or delete these rules.

Using the payment form widget with Slate Payments

  • No Partial Payments: Slate Payments deposit accounts have an option that can allow for partial payments. This option cannot be used with a payment form widget that collects payments.

  • No “Save for Later” Option: If the payment widget is using Slate Payments to collect a payment at time of form submission, do not use the “save for later” setting within Edit Properties of the form as this may lead to submission errors.


Was this article helpful?