Appearance
Gravity Forms
Requirements
- Wordpress website
- Active Gravity Forms plugin
- Active Gravity Forms Tokenizer plugin
- Active gateway merchant account
- At least one available form
Compatibility
- Tested versions: Wordpress: 6.1.1, Gravity Forms: 2.7.2
- Compatible with PHP 8.1+, Gravity Forms: 2.6+
WARNING
Version 1.0.0+ has major changes. Any versions below are not backward compatible. 1.0.0+ version is not backward compatible with older versions. Make sure to manually recreate your existing forms or change them according to the documentation.
Features
- Card and ACH Payment via the Tokenizer
- One-time and recurring subscription transactions
- Custom amount defined by end-user
- Customize Payment related info (Titles, amounts etc.)
- Allow transaction fields to be mapped with form field values
- Allow custom fields to be mapped with form field values
Installation
DANGER
Always backup your system before making any changes or upgrades!
WARNING
You need a valid Gravity Forms license to activate and use with our plugin.
- Download the latest release of this module
- Log in to your Wordpress Admin.
- On the Admin Panel click Plugins.
- On the top of Plugins page click on "Add New".
- On the top of the Add Plugins page click on "Upload plugin".
- Press the "Choose File" button to open the downloaded gravity-tokenizer-x.x.zip file and press the "Install Now" button.
- Once installed go to your Plugins page and click on "Activate" under the "Gravity Forms Tokenizer" plugin.
Setup
Basic settings
Go to Forms > Settings > Payment Gateway.
Endpoint URL: The base URL of the Gateway. The format is
https://app.domain.com
. For testing you can use the sandbox URLhttps://sandbox.domain.com
.Public Key: It is a public key required to load the Tokenizer form, you can obtain one from the control panel.
API Key: It is a private API key required to send transactions via the Gateway, you can obtain one from the control panel.
Card Pay: Users can pay with Card on the given form
ACH Pay: Users can pay with ACH on the given form
TIP
If you wish to display both payment methods on the form, check both options.
WARNING
Additional Tokenizer fields (User fields, Shipping address and Billing address) are NOT stored in Wordpress/Gravity Forms, it's only sent to the Gateway and processed there.
Adding Tokenizer
Create form
Create a new form (Dashboard > Forms > New Form) and choose the type of Form you want to create. Enter the name and description of the Form.
One-time payment
Add the non-payment blocks and configure them as you wish. Then add the payment related blocks for one-time payments as follows:
- Products Block: Add the amounts in the form of products to your form. Always add straight-forward and descriptive Labels because the users will need to make a decision based on the label displayed. Include the Price field too. This will be added to the total amount. The total amount will be included in the transaction.
- Total Block: Always add the total block to your form. It calculates the amount passed to the gateway and lets the end-user see the total amount.
- Tokenizer block: Add the tokenizer block. Enter the Field Label and Description to let your end-users know the expected actions.
Field Label: Title of the field visible to the users above the payment block.
Description: Description of the field visible to the users. It can be used to give specific hints or guidelines for the end users.
In the Gravity Forms Navbar go to Settings > Payment Gateway if you wish to change your default preferences for the tokenizer.
WARNING
The plugin only works if you include the Total block in your form.
TIP
Add an other option if you wish to let the user define the amount. Set its Price to $ 0.00. Add an Other Product block with User Defined Price.
Subscription
Add the non-payment blocks and configure them as you wish. Then add the payment related blocks for subscriptions the same way you would add one-time payments.
WARNING
Subscription period always starts with the first bill date of the subscription, which is the day when the end user submits the form.
In the Gravity Forms Navbar go to Settings > Payment Gateway iand change the transaction type to Recurring
. The Subscription Settings will appear at the bottom of the page.
With Basic Subscription Intervals:
Subscription Name: It will only be visible in the Description section of the Subscription in the Gateway. Enter a descriptive description so that the end-users will also recognize it on the transaction receipt.
Subscription Billing Frequency: Frequency of the subscription. It can be set to
Monthly
,Weekly
,Twice Monthly
.Subscription Duration: Number of periods the subscription will last. For example if the billing frequency is set to
Monthly
, set the duration to 12. That subscription will last for 12 months. Enterendless
to set the duration indefinite.
With Advanced Subscription Intervals:
Field for Configuring Subscription intervals:: Choose a previously created non-payment block. The interval of the subscription will be defined based on the options of this field. Always add straight-forward and descriptive Title because the user will need to make a decision based on that.
Billing cycle associated with field value: Frequency of the subscription. It can be set to
Daily
,Monthly
,Yearly
.Billing duration associated with field value:: Number of periods the subscription will last. For example if the billing frequency is set to
Monthly
, set the duration to 12. That subscription will last for 12 months. Enterendless
to set the duration indefinite.
Payment & Subscriptions
Add the non-payment blocks and configure them as you wish. Then add the payment related blocks the same way you would add otherwise.
Go to Payment Gateway in the Form Settings and change the transaction type to One-time and Recurring
. Two Subscription Settings related sections will appear below. Set is as follows:
*Tokenizer - Recurring field: Choose the block which will be responsible for the subscription logic. You can use a dropdown or radio button to create this logic.
TIP
Ask the end-user about the nature of the donation. Always ask straight-forward questions like Will this be a one-time or a monthly recurring transaction?
.
*Submit as recurring if field value is: Once you have chosen your Recurring field block, you need to choose the logic for the recurring transaction. If the end-user chooses the field set here, the transaction will be sent as a recurring subscription.
TIP
Always enter easily understandable options as answers. Use descriptive answers like One-time
or Recurring
instead of a simple Yes
or No
.
With Basic Subscription Intervals:
Subscription Name: It will only be visible in the Description section of the Subscription in the Gateway. Enter a descriptive description so that the end-users will also recognize it on the transaction receipt.
Subscription Billing Frequency: Frequency of the subscription. It can be set to
Monthly
,Weekly
,Twice Monthly
.Subscription Duration: