RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.
Widget Type:
Form Widgets
TPC Version:
  • 3.3 +
VideoLogos
The CRM Pay Button widget is used to pay towards a numeric field. It can also be used to generate an order. If the pay button widget is being used on a form that's configured to use the Orders entity, it will complete the order. If the pay button widget is being used on any other entity, it will add an item - the price of which is determined by the set numeric field in the total price attribute field - to your shopping cart and create a new order once you checkout. Please note that this widget will only work if you have an ecommerce enabled licence. 

Configuration

Basic Setup


  1. From the Portal Connector (Ecommerce) widget list, click and drag the CRM Pay Now Button into the body of your form. Please note that you will need to configure a shopping cart for this widget to function properly.

  2. In order for the widget to work, there a few settings that must be configured. Click on the edit button to display the properties prompt. It should look like this:

    CRM Pay Button Properties

  3. When you are finished configuring the widget, click save to save it.

Widget Properties

Basic Properties

Submit Action

This property will allow you to determine what will happen when a user clicks on the donate button. Firstly, None will simply do nothing other than submit the donation once the donation button has been clicked. Redirect to a Page will redirect the user to a specified page once the donation has been submitted. Finally, Refresh will refresh the entire page once a donation has been submitted.

Product Name Prefix

The Product Name Prefix property allows you to set a prefix for a newly created shopping cart item.

ID Attribute

The ID Attribute property will append a records' field (Such as full name or account number) to a shopping cart item. This can be used to distinguish items in a shopping cart.

Total Price Attribute

The Total Price Attribute property allows you to select any numerical field from which the total owing amount of the order will be determined. This will be reflected in the shopping cart as well.

Update Status

The Update Status property allows you to change the status of a record.

Restrict Payment with Status

The Restrict Payment with Status property allows you to prevent fulfillment on an order with a certain status. You may select multiple statuses to prevent the completion of an order on.

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

Submit Action

This property will allow you to determine what will happen when a user clicks on the donate button. Firstly, None will simply do nothing other than submit the donation once the donation button has been clicked. Redirect to a Page will redirect the user to a specified page once the donation has been submitted. Finally, Refresh will refresh the entire page once a donation has been submitted.

Product Name Prefix

The Product Name Prefix property allows you to set a prefix for a newly created shopping cart item.

ID Attribute

The ID Attribute property will append a records' field (Such as full name or account number) to a shopping cart item. This can be used to distinguish items in a shopping cart.

Total Price Attribute

The Total Price Attribute property allows you to select any numerical field from which the total owing amount of the order will be determined. This will be reflected in the shopping cart as well.

Update Status

The Update Status property allows you to change the status of a record.

Restrict Payment with Status

The Restrict Payment with Status property allows you to prevent fulfillment on an order with a certain status. You may select multiple statuses to prevent the completion of an order on.

Button Text

The Button Text property allows you to change the text that appears inside of a button associated with the widget.