PayPal Payments Pro Integration

Payment Integration Documentation Home

What is PayPal Payments Pro Integration?

PayPal Payments Pro lets your form visitors send payments using your form, and the integration allows you to accept payments directly on your form so users will never have to be forwarded to PayPal and updates your results with the real-time status of each transaction.

Paypal Payments Pro Integration


  • Pro 1 or higher Formsite account.
  • PayPal Payments Pro account.

Formsite's PayPal Settings

Your form's PayPal Payments Pro settings are controlled on your form's "Form Settings->Payments" page. In order to enable PayPal Payments Pro integration for your form, it must have at least one order form (Pricing) item.

To setup your form, first get the API credentials from your PayPal account. Please note that these are separate from the information you use to login to your PayPal account. To get this information:

  1. Log into your PayPal account.
  2. Your PayPal account may appear with a couple different menu options. Click "Profile" in the top row of the page if you have this option, or if not, click the "Seller preferences" link that should be at the lower left.
  3. At the "My Profile" page, under either the "My selling tools" or "Selling online" section, find the "API Access" row and click "Update".
  4. At the "API Access" page, under the "NVP/SOAP API integration" section, click the link to "Request API Credentials", or "View API Signature" if you have already setup API credentials in the past
  5. If you have not already requested API credentials in the past, you may need to agree to the API credentials usage terms using the "Agree and Submit" button on the following confirmation page.
  6. You should now be at the "View or Remove API Signature" page. Here you can click the "Show" links for each of the "API Username", "API Password", and "Signature" fields. This is the information that you will need to copy and enter on the "Form Settings->Payments" page.

After you enter your credentials and configure the other settings, setup the PayPal Field Mappings. These settings allow you to edit the name of each of the payment fields that will be shown on your form by typing in the new label in the text field. You can also use the dropdown boxes to select an existing item on your form to map the PayPal field to, allowing you to default the payment field's value to the result that the user enters elsewhere on your form. Any mappings that are left blank will just not be populated when the user gets to the order summary/payment page. The country code fields allow you to set a default country rather than mapping to an item on your form. Credit card fields don't need to be mapped since it is not necessary to collect credit card information on your form. PayPal Payments Pro Integration provides credit card handling and PCI compliance.

Advanced users can pass additional integration parameters directly to PayPal by enabling the "Use Additional Parameters" setting. Additional Parameters must be supplied in the format Field=Value (for example, See the PayPal API Reference for more details. We recommend adding shipping and other fees as items on your form rather than as Additional Parameters.

Some settings specific to PayPal are controlled from within your PayPal account.

Recurring Billing (Subscriptions)

When using the Recurring Billing options, the Recurring Amount can be either the Order Total from your Form or a Fixed Amount. Moreover, you can specify a One-Time Fee to be charged to the user immediately, in addition to the recurring charges. The form's Order Total must be used for either the Recurring Amount or the One-Time Fee, if not both. The Description fields should be used to describe the charges, as the description for any Fixed Amount charge will be displayed as a line item in the order summary that is displayed to the user and in various results formats.

When Recurring Billing is enabled, the One-Time Fee will be charged immediately after your form is submitted. A Recurring Payments Profile will be created inside your PayPal account for the recurring charges.

Due to the unique functionality of PayPal Pro's Recurring Billing, it can only be combined with the Pay by Check payment method.

Viewing PayPal Payments Pro Results

Once PayPal Payments Pro integration has been enabled for your form, you can view the status of a result's PayPal Payments Pro transaction by using the "Results->Results Table" page. Each result row will have a "History" link for more information and one of the following status icons:

Payment SuccessfulThe payment was successful.
Extra InformationThe payment was successful, but additional information is also available, such as a refund or duplicate order. The order also may have been updated, changing the total amount.
Payment IncompleteThe payment has not yet completed or your account is not set up correctly.
Payment FailedThe payment attempt failed.

NOTE: Your PayPal account is the final record of all payments and refunds. There should not be a discrepancy between PayPal and Formsite, but in the event that this situation arises, PayPal takes precedence over Formsite.

PayPal Error Messages

The "Security headers is not valid" error message can occur due to incorrect PayPal account information on the "Form Settings->Payments" page.

For more information about PayPal's error messages, see their API Errors Reference page.

Additional Information

When any payment integration is enabled, you can also set the Conditional Logic in your Notifications to send either before the user pays ("Before Payment") or only after a successful payment ("After Successful Payment").

Advanced Fraud Management Filters is an extra service option that you can add to your PayPal Payments Pro account. This will add the Address Verification Service (AVS) and Card Security Code (CSC, CVV2) checks, among other things. If you do not have this enabled, or do not require CVV2 authorization, Card Verification Value (CVV2) failures will be noted for your transactions but will not cause payments to fail.

PayPal - Visa, MasterCard, Discover, Amex

Payment Integration Documentation Home