PayPal Website Payments Pro

About this Module

In WHMCS 8.9 and later, we strongly recommend the PayPal Payments payment gateway module for processing payments with PayPal. This module includes all of the latest features for securely processing payments via PayPal, including support for credit and debit cards.

For information on all of our PayPal integrations, see PayPal.

The PayPal Website Payments Pro payment gateway module is available in WHMCS.

Supported Features

Type	One Time	Recurring	Refunds	3D Secure
Credit Card	Yes	Yes	Yes	Yes

Adding the PayPal Website Payments Pro Payment Gateway

To set up the PayPal Website Payments Pro payment gateway in WHMCS:

Go to the appropriate location for your version of WHMCS:
- For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
- For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
Click PayPal Website Payments Pro.
Check Show on Order Form to display this payment method in the Client Area during checkout.
Retrieve your details for the Payflow Pro API:

PayPal API Step 2
1. Log in to PayPal.
  
  PayPal API Step 2
2. Select your name and company at the top right.
3. From the menu, select Account settings.
4. Scroll down and select Website payments.
5. Select Update for API Access.
6. Under NVP/SOAP API integration (classic), select Manage API credentials.
7. Copy the API credentials.
Enter your PayPal credentials.
- 3D Secure uses Processor ID, Merchant ID, and Transaction PW. PayPal Pro Accounts are usually enrolled for this by default.
  - If you are enrolled, PayPal will provide the details.
  - If they haven't or you don't want to use the 3D Secure feature, leave these fields blank.
Click Save Changes.

Test Mode

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

PayPal Pro Reference Payments

This module does not support adding or updating card data via the Admin Area. Instead, admins can do this by paying an invoice on behalf of a client.

This gateway helps reduce your PCI compliance liability. Instead of storing card details, the ID of the last transaction is used to make repeat charges. If you use this, clients must reenter their card details to change payment gateways.

Supported Features

Type	One Time	Recurring	Refunds	3D Secure
Token	Yes	Yes	Yes	No

Remote Update Card	Remote Delete Card	AddPayMethod API
No	No	Yes

Adding the PayPal Pro Reference Payments Payment Gateway

To set up this payment gateway in WHMCS:

Go to the appropriate location for your version of WHMCS:
- For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
- For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
Click PayPal Pro Reference Payments.
Check Show on Order Form to display this payment method in the Client Area during checkout.
Enter your PayPal Pro Reference Payments credentials.
- Processor ID, Merchant ID, and Transaction PW are used by the 3D Secure process.
  - PayPal Pro accounts are enrolled for this by default. If you are enrolled, PayPal will provide details.
  - If they haven't or you don't want to use the 3D Secure feature, leave this information blank in WHMCS. This will disable the 3D Secure process and WHMCS will not use it during the checkout process.
- To find your details for the Payflow Pro API:
  1. Log in to PayPal.
  2. Go to Profile > My selling preferences > API Access.
    
    PayPal API Step 2
  3. Choose Option 2 to request API credentials to create your own API username and password.
  4. Choose Request API signature.
  5. Click Agree and Submit.
  6. Copy the provided username, password, and signature.
  7. Click Done.
Click Save Changes.

Limitations

PayPal applies a time limit for repeating against a transaction. 24 months after the original payment, you will see a Referenced transaction or order is too old error.

To resolve this, the client must log in and submit payment manually. This will generate a new transaction that further repeats can be made against. Whenever a client pays manually via the Client Area, it is stored as the most recent transaction for any further repeats to be made against. The standard "Credit Card Payment Declined" email template will send to a client when the capture fails due to the expired reference transaction.

Declined Payments

If you experience an error while processing payments, go to Billing > Gateway Log. The full response from PayPal is displayed in the debug field. Refer to the L_ERRORCODE0 value, and the following two values will then briefly explain the error.

L_SHORTMESSAGE0 => Security error indicates that the API details you entered at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways are invalid.

For more detailed descriptions of the errors and instructions for correcting them, click here.