Author 诗语

PayPal Standard Feed Meta

IntroductionUsagePropertiesProduct or Donation Transaction PropertiesSubscription Transaction PropertiesDelayed Payment Properties

Introduction
The Feed Object meta for the PayPal Standard add-on is an associative array containing the properties which determine what type of transaction should occur and what values are sent to PayPal.
12345678910$feed['meta'] = array(    'feedName'                                => 'Your Feed Name',    'paypalEmail'                             => '[email protected]',    'mode'                                    => 'test',    'transactionType'                         => 'product',    'feed_condition_conditional_logic'        => true,    'feed_condition_conditional_logic_object' => array(        'conditionalLogic' => array(),    ),);
Usage
We recommend accessing the $feed meta using the rgar() or rgars() function, e.g.:
1$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );

Properties

feedName string
The feed name which appears on the add-ons feeds tab.

paypalEmail string
The PayPal email address where payment should be received.

mode string
Determines if the PayPal development sandbox should be used when testing or if live payments should be received. Possible values: production or test.

transactionType string
The type of transaction which should occur when the feed is processed. Possible values: product, subscription or donation.

billingInformation_firstName string
The ID of the field containing the customer』s first name.

billingInformation_lastName string
The ID of the field containing the customer』s last name.

billingInformation_email string
The ID of the field containing the customer』s email.

billingInformation_address string
The ID of the field containing the first line of the customer』s address.

billingInformation_address2 string
The ID of the field containing the second line of the customer』s address.

billingInformation_city string
The ID of the field containing the city of the customer』s address.

billingInformation_state string
The ID of the field containing the state of the customer』s address.

billingInformation_zip string
The ID of the field containing the zip of the customer』s address.

billingInformation_country string
The ID of the field containing the country of the customer』s address.

pageStyle string
Which PayPal page style should be used if you have setup a custom payment page style with PayPal.

continueText string
The text that should appear on the continue button once payment has been completed via PayPal.

cancelUrl string
The URL the user should be sent to should they cancel before completing their PayPal payment.

disableShipping boolean
Do not prompt buyer to include a shipping address. Default false.

disableNote boolean
Do not prompt buyer to include a note with payment. Default false.

delayNotification boolean
Send out selected notifications only after payment has been received. Default false.

selectedNotifications array
An array of notification IDs which should be delayed.

feed_condition_conditional_logic boolean
Is the feed condition (conditional logic) setting enabled. Default is false.

feed_condition_conditional_logic_object array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

Product or Donation Transaction Properties
The following properties are only applicable when the transactionType is set to product or donation.

paymentAmount string
What to use for the payment amount. Possible values: form_total or a product field ID.

Subscription Transaction Properties
The following properties are only applicable when the transactionType is set to subscription.

recurringAmount string
What to use for the recurring amount. Possible values: form_total or a product field ID.

billingCycle_length integer
How often should the recurring payment occur. Maximum values: 90 days, 52 weeks, 24 months or 5 years.

billingCycle_unit string
What unit to use with the billingCycle_length. Possible values: day, week, month or year.

recurringTimes integer
How many times the recurring payment should be made. The default (0) is to bill the customer until the subscription is canceled.

recurringRetry boolean
Try to bill again after failed attempt. Default is false.

trial_enabled boolean
Should the recurring charge occur immediately or after a trial period? Default false.

trial_product string
What is the source of the amount the user should be charged during the trial. Possible values: enter_amount or a product field ID.

trial_amount string
The amount the user should be charged during the trial if enter_amount is selected for the trial_product.

trialPeriod_length integer
How long should the trial last. Maximum values: 90 days, 52 weeks, 24 months or 5 years.

trialPeriod_unit string
What unit to use with the trialPeriod_length. Possible values: day, week, month or year.

Delayed Payment Properties
The following properties are only applicable when the 「action only when payment is received.」 options are being used.

type string
See transactionType. Only for backwards compatibility with non-framework add-ons.

recurring_amount_field string
See recurringAmount. Only for backwards compatibility with non-framework add-ons.

update_user_action string
User Registration add-on integration. What role should the user be assigned when the subscription is cancelled.

update_site_action string
User Registration add-on integration. Update site when the subscription is cancelled. Possible values: deactivate or delete.

delay_registration boolean
User Registration add-on integration. Register user only when payment is received.

delay_gravityformsaweber boolean
Aweber add-on integration. Subscribe user to AWeber only when payment is received.

delay_gravityformscampaignmonitor boolean
Campaign Monitor add-on integration. Subscribe user to Campaign Monitor only when payment is received.

delay_gravityformsmailchimp boolean
MailChimp add-on integration. Subscribe user to MailChimp only when payment is received.

delay_gravityformstwilio boolean
Twilio add-on integration. Send SMS only when a payment is received.

delay_gravityformszapier boolean
Zapier add-on integration. Send feed to Zapier only when payment is received.

Obtaining and Saving your FreshBooks API Credentials

Note: As of September 2016, FreshBooks has released a new version of their service. Currently, the Gravity Forms FreshBooks Add-On only works with the previous FreshBooks Classic version and will not work with their updated API.

To begin using the FreshBooks Add-On, you will first need to obtain and save your FreshBooks API settings. In this article, we will show you how to get started with obtaining your FreshBooks API credentials, as well as saving them inside the settings page.

Log into your FreshBooks account.Click on My Account at the top right of the page.Click on FreshBooks API.You should now see your API URL as well as your Authentication Token. Make note of these as you will be inputting them into the FreshBooks Add-On shortly.Log into your WordPress admin dashboard and hover over Forms, then click on Settings.

Click on the FreshBooks tab.

You will see two fields, Site Name and Authorization Token. Within the Site Name field, enter only the beginning of your API URL. For example, if your full API URL reads https://exampleuser.freshbooks.com/api/2.1/xml-in, simply enter exampleuser into this field. In the Authorization Token field, enter the authorization token that you obtained from FreshBooks.Click the Update Settings button to save your changes.

You have now successfully configured the FreshBooks Add-On for Gravity Forms to communicate with the FreshBooks API. You』re now ready to setup a feed within the FreshBooks Add-On.

PayPal Field

IntroductionCommon SettingsGeneral SettingsSupported Payment MethodsDefault Payment MethodSub-LabelsSupported Credit CardsCard Icon StyleAppearance SettingsPayPal Smart Payment ButtonsPayPal Credit MessagesAdvanced SettingsForce SSL

Introduction

The PayPal Field will appear in the Pricing Fields group, in the Form Editor, when the Gravity Forms PayPal Checkout Add-On is installed and active.

Note that a pre-configured feed will be created in the Form Settings > PayPal Checkout area when a form containing a PayPal Field is saved, and a feed does not already exist.

Common Settings

For a description of each of the common field settings, refer to this article. Below you will find descriptions of specialty settings that are particular to this field.

General Settings

The General settings for the PayPal Field allow you to configure the Field Label, Description, Supported Payment Methods, and if the field is Required.

Supported Payment Methods

The PayPal Field supports the following payment methods:

Payment MethodNotesPayPal CheckoutIf selected, additional options may be enabled. Refer to the Appearance section below. Credit CardThis payment method is in limited release with PayPal, and not available in all markets. Refer to this document for some additional detail, and check with PayPal for the most up-to-date information.

Default Payment Method

The Default Payment Method setting is displayed when both payment methods are selected. It allows you to set the default option in the payment method drop down when the field is displayed.

Sub-Labels

The Sub-Labels settings are displayed when the Credit Card payment method is selected; they allow you to define custom sub-labels for the credit card inputs. You can also hide the Cardholder Name input.

Supported Credit Cards

The Supported Credit Cards settings are displayed when the Credit Card payment method is selected; this provides a visual indicator to your credit card fields when users are filling in their payment details. You can select from:American Express*; Discover; MasterCard; Visa; Maestro.

(*) PayPal Checkout only supports American Express and Discover for accounts registered in the U.S. and accepting U.S. Dollars.

Card Icon Style

The Card Icon Style setting is displayed when the Credit Card payment method is selected; it controls which style of credit card icons will be used, standard or 3D.

Appearance Settings

PayPal Smart Payment Buttons

When using the PayPal Checkout payment method, PayPal may display Smart Payment Buttons for some of the following funding sources:Credit or debit cards; PayPal Credit; Venmo; SEPA-Lastschrift; Bancontact; eps; giropay; iDEAL; MyBank; Przelewy24; Sofort;  …and maybe more. 

Whether these are presented as payment options to a customer is determined by PayPal at the time of presentation, and is based on factors such as the merchant and the purchasers region, specific PayPal account terms etc. For more information on options available to your account, contact PayPal. 

Funding sources can be disabled using the gform_ppcp_disable_funding filter.

Using the following settings you can customize the appearance of the Smart Payment Buttons using the following settings:

SettingOptionsLayoutVertical or HorizontalSizeResponsive, Large, Medium, or SmallShapeRectangle or PillColorGold, Blue, Silver, White, or Black

PayPal Credit Messages

Enabling this setting allows PayPal to present Pay Later offer messages to your customers, that may provide alternative payment arrangements. What is offered in those messages is determined by PayPal, and based on factors they evaluate such as account terms, region of customer and merchant etc. See this PayPal document for information, and contact PayPal with any questions. 

This setting is only offered if PayPal Checkout was enabled. 

Advanced Settings

The Advanced settings for the PayPal Field allow you to configure the Admin Field Label, Force SSL, and Conditional Logic.

Force SSL

When enabled and the form is displayed on an insecure (non-https) page the field will attempt to redirect the user to the https version of the page. Your site will need an SSL certificate for this to function correctly. Contact your web host if you need assistance purchasing and configuring an SSL certificate.

Number

SummaryCommon SettingsGeneral SettingsNotesMerge TagsUsageModifiers

Summary

The Number field allows a user to enter a number. The field then automatically validates the form data to insure that a number was entered. You can also set a minimum and maximum number and the field will validate that the entered data is within that range. It is available under the Standard Fields section within the form editor.

Number field as displayed in the Field Library

Number field as displayed in the Form Editor.

Common Settings

This field uses only common field settings for the Appearance and Advanced settings. For a description of each of the common field settings, refer to this article. Below you will find description of specialty settings that are particular to this field.

General Settings

SettingDescriptionNumber FormatSelect the format of numbers that are allowed in this field. You have the option to use a comma or a dot as the decimal separator.RangeEnter the minimum and maximum values for this form field. This will require that the value entered by the user must fall within this range.Enable CalculationEnabling calculations will allow the value of this field to be dynamically calculated based on a mathematical formula. See note 1.

Notes

1. See this article for an example and the rules on using numbers in calculations.

Merge Tags

For more information on the use of merge tags, refer to these articles.

Usage

{Field Name:2:modifier}

Modifiers

ModifierDescription:valueTells the merge tag to not use a thousands separator, and instead use the numeric value of the field. Not applicable to currency values.

Poll Merge Tags

{all_poll_results}{gpoll}

The Polls Add-On introduces two new Gravity Forms Merge Tags that can be used anywhere within Gravity Forms where merge tags are supported. Merge Tags are primarily used in the Form Confirmation message and Notification messages to output the results of a Poll Field or All Poll Fields within the content of the message. The Polls related merge tags also introduce parameters to the Gravity Forms Merge Tags.

{all_poll_results}

Displays the results of all Poll Fields that exist in the form.

Example:

{all_poll_results: style="green" percentages="true" counts="false"}

Following image shows how the above example of the all_poll_results merge tag may look on output.

ParameterDescriptionstyleThe add-on currently supports four built in styles: red, green, orange, blue. Defaults to 『green』. (optional)percentagesDisplay results percentages as part of results. Supported values are: true, false. Defaults to 『true』. (optional)countsDisplay number of times each choice has been selected when displaying results. Supported values are: true, false. Defaults to 『true』. (optional)

{gpoll}

Displays the results of a specific Poll Field defined in the merge tag.

Example:

{gpoll: field=2 style="red" percentages="true" counts="true"}

Following image shows how the above example of the gpoll merge tag may look on output.

ParameterDescriptionfieldThe id of the field you would like to display. (required)styleThe add-on currently supports four built in styles: red, green, orange, blue. Defaults to 『green』. (optional)percentagesDisplay results percentages as part of results. Supported values are: true, false. Defaults to 『true』. (optional)countsDisplay number of times each choice has been selected when displaying results. Supported values are: true, false. Defaults to 『true』. (optional)

Partial Entries Change Log

1.6.11.6 | 2020-09-241.5 | 2020-05-111.4 | 2019-08-071.3 | 2018-12-191.2 | 2018-03-271.1 | 2018-01-291.0 | 2016-09-231.0-beta-2 | 2016-03-301.0-beta-1 | 2016-03-17

1.6.1

Added the gform_partialentries_pre_update filter to allow modifying the partial entry data before it is updated.
Fixed an issue that was causing an unsaved change notice to display each time partial entries was enabled or disabled in the form settings.

1.6 | 2020-09-24

Added support for Gravity Forms 2.5.

1.5 | 2020-05-11

Added translations for Hebrew, Hindi, Japanese, and Turkish.
Fixed an issue where values for fields located in sections or pages which are hidden by conditional logic are being saved to the partial entry.

1.4 | 2019-08-07

Added security enhancements.
Added support for anti-spam honeypot validation prior to creation of partial entry.
Fixed "?gf_token" being saved as the value of the resume_url entry meta when a draft submission has not been saved.

1.3 | 2018-12-19

Updated minimum Gravity Forms version to 2.3.
Fixed issues with conditional logic evaluation when the entry is saved during form submission.
Fixed a PHP notice with Gravity Forms 2.3+ when save and continue is enabled for the form.
Fixed an issue where a completed entry could be overridden by a partial entry when an expired resume token is used.
Fixed a PHP notice which could occur during submission if the form contains one or more product fields.
Fixed issue where entry count did not match list of entries in certain scenarios.

1.2 | 2018-03-27

Added security enhancements.
Fixed an issue preventing automatic upgrades.

1.1 | 2018-01-29

Added Author URI to plugin header.
Added support for Gravity Forms 2.3.
Updated Plugin URI in plugin header to be https.
Updated the feed conditional logic progress choices to support the "is" operator.
Updated the "Complete" choice of the "Progress" entry meta item to support the "is not" operator.
Updated text "Enable Condition" to "Enable" in making Add-Ons consistent.
Updated partial-entries.js to include heartbeat.js as a dependency.
Fixed the handling of the "No Duplicates" field setting where validation fails on submission if a partial entry contains a duplicate value. The "No Duplicates" setting is now ignored when saving partial entries. Partial entries are now ignored when checking for duplicates on final submission - only complete entries are checked.
Fixed a PHP notice while viewing the entry list with WordPress 4.8.3.
Fixed a PHP notice during partial entry creation if the form includes a fileupload type field.

1.0 | 2016-09-23

Added the form_partialentries_post_{$event} hook enabling custom actions to be performed once a partial entry has been saved or updated.
Updated to set entry meta (e.g. Quiz Score Total) when a partial entry is saved/updated.
Fixed issues with saving partial entries and with submitting the form when one of the fields has the "No Duplicates" setting enabled.
Fixed an issue with the form submission where previously saved values are not deleted when subsequently hidden by conditional logic.
Fixed an issue which caused the form to be validated twice during page changes.
Fixed an issue which caused GFFormDisplay::is_last_page() to return an incorrect result causing payment add-ons to perform credit card field validation on the wrong page.

1.0-beta-2 | 2016-03-30

Added support for Gravity Forms 2.0-beta-2.
Added the Last Saved date and link to the entry detail page.
Added the gform_pre_render filter before creating the partial entry.
Added support for notification events (sending notifications when the partial entry is saved and updated).
Added logging statements.
Fixed PHP warning on notifications list and edit pages.
Fixed an issue with the warning message.
Fixed the text domains used for some of the translatable strings.

1.0-beta-1 | 2016-03-17

All new!

PayPal Pro – Sending a Custom Product Label and Description

If you need to define a custom product name and description within PayPal using the PayPal Pro add-on, this snippet will allow you to do so:
12345678910111213141516add_filter( 'gform_paypalpro_query_1', 'add_additional_information', 10, 3 );function add_additional_information( $query_string, $form, $entry ) {     // break the query string into an array after removing the initial '&' character    parse_str( ltrim( $query_string, '&' ), $query );     // Set your custom values    $query['L_NAME0'] = 'Your custom product name here';    $query['L_DESC0'] = 'Your custom description here';     // put it all back together again    $query_string = '&' . http_build_query( $query );     // return the query string    return $query_string;}
In this snippet change gform_paypalpro_query_1 to the ID of your form.

Option Field CSS Selectors

ContainerDrop DownItems

Container
example: option field container (div) – applies to all forms
body .gform_wrapper .gform_body .gform_fields .gfield_price .ginput_container_select {border: 1px solid red;}
example: option field container (div) – applies just to form ID #1
body .gform_wrapper_1 .gform_body .gform_fields .gfield_price ginput_container_select {border: 1px solid red;}
example: option field container (div) – applies just to specific container (based on the unique parent element ID – replace 「XX_X」 with your actual element ID)
body .gform_wrapper_1 .gform_body .gform_fields #field_XX_X.gfield_price ginput_container_select {border: 1px solid red;}
Drop Down
example: option field drop down (select) – applies to all forms
body .gform_wrapper .gform_body .gform_fields .gfield_price .ginput_container_select select {border: 1px solid red;}
example: option field drop down (select) – applies just to form ID #1
body .gform_wrapper_1 .gform_body .gform_fields .gfield_price .ginput_container_select select {border: 1px solid red;}
example: option field drop down (select) – applies just to specific container (based on the unique parent element ID – replace 「XX_X」 with your actual element ID)
body .gform_wrapper_1 .gform_body .gform_fields #field_XX_X.gfield_price .ginput_container_select select {border: 1px solid red;}
Items
example: option field items (option) – applies to all forms
body .gform_wrapper .gform_body .gform_fields .gfield_price .ginput_container_select select option {border: 1px solid red;}
example: option field items (option) – applies just to form ID #1
body .gform_wrapper_1 .gform_body .gform_fields .gfield_price .ginput_container_select select option {border: 1px solid red;}
example: option field items (option) – applies just to specific container (based on the unique parent element ID – replace 「XX_X」 with your actual element ID)
body .gform_wrapper_1 .gform_body .gform_fields #field_XX_X.gfield_price .ginput_container_select select option {border: 1px solid red;}

PayPal Payments Pro Add-On Requirements

Requirements

There are various things required when using the PayPal Payments Pro Add-On. The biggest of these being a valid SSL certificate installed and configured on your server. If you』re not sure about this, contact your web host for more information.
Requirements

Gravity Forms v1.9.16+
Latest version of WordPress
SSL Certificate Installed and Configured
PCI Compliance
PayPal Payments Pro account with PayFlow API support.

Obtaining Your Breeze API Key

Before you can use the Gravity Forms Breeze Add-On, you will first need to obtain your API key from Breeze. In this article, we will show you how to do so with just a few steps.

Log into your Breeze account.
Click on your name at the top right corner, then click on Personal settings & password.
Click on the Integrations tab. You will see your API token here. Copy this as you will need it within Gravity Forms.