Regardless of how payments are eventually collected, the form payment widget can be used to calculate payment due amounts and create Payment Due activities or interactions.
If you use the built-in Slate Payments gateway, payment can be collected right within the form. This can streamline the process of collecting an event payment or a deposit, and can allow for payment to be required in order to submit the form.
Note: The 'allow partial payments' setting (an option on a particular Slate Payments deposit account) cannot be used with a form payment widget that is set to collect payment.
Payment widgets can be used on person, application, and dataset-scoped forms. This does not include Page Construction or Page Construction Widgets types. Make sure that relevant form fields are mapped to the correct system fields so that the relevant record can be created (or matched) upon form submission and the resulting payment activity/interaction and payment record can be properly connected.
Payment widgets should be extensively tested on all forms before the form is made live. It is not recommended to feature a payment widget on an embedded form.
Important!
A form should only have one payment widget that collects payments. Slate can calculate different payment due amounts using the payment widget's "Payment Due Calculation Formula or Amount" setting.
- Click Forms in the top navigation bar.
- Drag and drop the Payment widget onto the form page.
- Select the payment account to be associated with the payment activity/interaction.
- Select whether to (a) embed the payment collection on the form (for Slate Payments only) or (b) 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). - Option - 'Internal Only' ... only choose this option if the payment widget should only be loaded for internal form registrations.
- Option - 'Create New Payment Due for Each Submission' ... select this option if it is possible that the same user will submit this form multiple times (e.g. giving form) and different points in time.
- Click Save.
Important!
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.
A payment due calculation formula or amount may be added to a form by leveraging fields on the form. For example, the screenshot in the section below demonstrates a cost for the registrant, plus a cost for guests multiplied by the number of guests. This calculation can determine the total amount due. The payment amount calculation will work the same as any calculation formula in a form field.
If the payment amount is fixed, simply add a number. (In this case, just add the number itself -- no dollar sign or other text.)
When using the widget to calculate the payment amount but not 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 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.
