Plugin - Payment Package (Wire Transfer, PayPal)

The Payment Package allows you to use the Payment Plugin with RSForm! Pro and to setup payments using PayPal or Offline payments.

The PayPal Plugin has been redesigned to allow multiple payment options on the same form, as well as a new "Quantity" and a "Donation" field.

Downloading and Installing the plugin

Download

This plugin can be downloaded by logging into our website using the account that holds the RSForm!Pro active subscription, heading to Downloads > RSForm!Pro > view all plugins and modules > RSForm! Pro Files > Plugins and clicking on the Payment Package (Payment Plugin + PayPal + Offline)

Install

In order to install the plugin you will have to log in into your admin panel and head to Extensions > Extension Manager > Install tab > browse for the pkg_payment.zip archive downloaded from our website and hit the Upload & Install button.

Plugin configuration

After installing the package you will notice that two tabs have been added within your RSForm!Pro Configuration page: Payments and PayPal each one with its own configuration options.

Payments

Using this tab you can configure the following options:

• Currency: Enter a 3-character currency code, for example USD - United States Dollar. Please consult this list when setting up your preferred currency.
• Thousands Separator: Set a character to separate thousands. By default, this is set to , (comma)
• Decimal Separator: Set a character to separate decimals. By default, this is set to . (dot)
• Number of Decimals: Set a number of decimals to work with
• Product Price Mask: Use the following placeholders to define a price mask for your multiple products fields: {product}, {price} and {currency}. You can place them in any order you like, and separate them by any characters or text. The multiple product fields' items will be generated based on this price mask
• Total Price Mask: This is how the total price will be shown in the frontend. Use the following placeholders: {price} shows the price, {currency} shows the currency, {grandtotal} show the price with the tax included and {tax} shows the value of the tax. You don't need to use them all so you can always hardcode the values if you need to do so, eg. ${price}

PayPal

In this tab are available the following options:

• PayPal E-mail Account: the email address you have used when creating your PayPal account
• Return URL: Optional, provide an URL to which the users will be redirected after finalizing the payment
• Cancel URL: Optional, provide an URL to which the users will be redirected after cancelling the payment
• Live Mode: Yes / No - set to No in order to enable the testing mode
• Tax Type: Percent (%) / Fixed Rate - Optional, set how you want to tax the form submitters - by a percentage of the total or by a fixed value
• Tax Value: Set the value that will be applied in conjunction with the Tax Type field. Leave blank if you do not wish to apply a tax
• Language code: Provide a 2-character language code. Please consult the Countries and Regions Supported by PayPal list for more information

Available fields

The new Payment Plugin is the one in charge of specifying what needs to be paid. It adds the following fields to the form:

Single Product:

Adds a single product to the form. The user will be redirected to the payment page upon submission. For this type of field you can set up a caption, description and a price. Being a single use field (you can add only one in a given form), its internal name will always be the same, rsfp_Product.

Multiple Products:

Adds the ability to display multiple products to be purchased either in a Dropdown or a Checkbox. Its items need to be specified in the following manner:

price|label                for example:    15|T-shirt

Donation:

Allows the user to type in the amount to be paid inside a standard Textbox. A default value can also be set and, using HMTL attributes, you can render the field as readonly in order to have a fixed value for the donation (by adding readonly="readonly" in the field's Additional Attributes area).

Configuration options:

• Type: Text | Number | Range
• Minimum Value: This is the minimum value (number) allowed for the input field.
• Maximum Value: This is the maximum value (number) allowed for the input field.
• Step: This is the step for the input field. If you want to allow decimals, consider adding 0.1 here instead of 1.

Quantity:

The quantity fields allows the user to choose the amount of products (simple or multiple). A default value can also be set and, using HMTL attributes, you can render the field as readonly in order to have a fixed value for the donation (by adding readonly="readonly" in the field's Additional Attributes area).

Configuration options:

• View Type: Dropdown / Textbox.
• Attach to: Select which payment field this quantity is attached to. This will multiply the payment field's value by the quantity specified in this field.
• Minimum Value: This is the minimum value (number) allowed for the input field.
• Maximum Value: This is the maximum value (number) allowed for the input field.
• Step: This is the step for the input field. If you want to allow decimals, consider adding 0.1 here instead of 1.

Discount:

This field allows users to setup a Discount through Coupon Codes which can be found under Additional Attributes area. Add each value on a new line in the form of discount|code.

For example: 5%|DISCOUNT5 (which will give a 5% discount) / 15|ANOTHERCODE (which will give a flat 15 discount). You can also use PHP code in here to generate your discount codes.

{discount} and {discountprice} placeholders can be used to return the discount itself or respectively, the calculated discounted amount.

Total:

This field is used alongside the Donation, Single and Multiple Products fields. It calculates the total price to be paid.

Choose Payment:

Allows the user to choose his payment method. It displays the payment methods added to the form in either a Dropdown or Radio Group (the radio group provides extra options such as Show Payment Icons or being able to set the radio group Flow: vertical/horizontal). It can be shown on the form (allowing the user to select his preferred payment method) or not (forcing the user to pay using the default payment method).

Multiple Payment Methods

After adding the payable "products" to your form, you need to add the Payment methods. The Payment methods have a (Payment) keyword in front of their name. When adding a new field you have the possibility of naming it (inside the "Label" field), so please use something descriptive (such as "Pay using your Credit Card through PayPal"). This label will appear in the "Choose Payment" field, as a Dropdown or Radio Group value. To this date, the Payment methods are:

• (Payment) PayPal: allows the user to pay for his purchase using "PayPal Payments Standard" (ie the user is redirected to www.paypal.com where a purchase can be completed by using a credit card or a PayPal account)
• (Payment) Offline: allows the user to pay using an offline payment method, such as a wire transfer. The details can be added in the "Wire transfer details" field, under the "Attributes" tab. You can use the {offline} placeholder in the Thank You Message or inside your emails to display this information to the user. If the Payment method is not "Offline" the placeholder will be replaced with a blank value.
  A Tax can be set for this particular payment as well. It can either have a Percentual or a Fixed value

In order to redirect the user successfully to the Payment processor you'll have to add the "Choose Payment" field as well as at least one Payment method. For legacy reasons, adding the PayPal Payment method without a "Choose Payment" field will automatically redirect the user to PayPal. This does not happen for the Offline Payment method. If you do not wish to display the "Choose Payment" field (eg. if you have only one payment option) you can always set the "Show in front-end?" attribute to "No". You can also use CSS to achieve the same effect if you are using a custom form layout without the "Auto Generate layout" option.

A full list of payment specific placeholders

(totalField and productField would be the actual field naming you've given to your elements; case sensitive):

Sending emails after the payment is made

You can now defer emails until after the payment is made. By going to the "Properties" main tab and scrolling down to "Payment Email Settings" you now have the following options:

• Defer User Email: By setting this to "Yes" the User Email will be sent when the purchase is confirmed by the Payment gateway.
• Defer Admin Email: By setting this to "Yes" the Admin Email will be sent when the purchase is confirmed by the Payment gateway.
• Defer Additional Emails: By setting this to "Yes" all of the Additional Emails will be sent when the purchase is confirmed by the Payment gateway.
• Disable Deferring Emails for Offline Payments: By setting this to "Yes" all of the Emails will be skipped from deferring when the purchase was made using Offline Payment
• Defer Silent Post: By setting this to Yes, the 'Post to Location (Silent Post)' will not be executed until payment is received. To ensure this is working correctly, you'll need to set 'Silent' to 'Yes' in your configuration, as usually payment confirmation is done without browser interaction.
• Defer Mappings: By setting this to Yes, the 'Mappings' section of the form will not be executed until payment is received.