Difference between revisions of "PayPal Payments Pro"

From WHMCS Documentation

(3D Secure)
Line 5: Line 5:
 
To activate the module, begin by going to '''Setup > Payment Gateways''' and choosing "PayPal Website Payments Pro" from the available list of gateways to activate.
 
To activate the module, begin by going to '''Setup > Payment Gateways''' and choosing "PayPal Website Payments Pro" from the available list of gateways to activate.
  
Once it's been added, you will then be asked for your '''API Username, Password & Signature'''.  These are obtained inside your PayPal account and we have a guide showing exactly how to do this @ http://wiki.whmcs.com/PayPal#Automated_Refunds
+
====API Details====
 +
 
 +
[[File:Pp_api1.png‎|thumb|PayPal API Step 1]]
 +
Once activated, you then need to enter your details for the PayPal Pro API. These can be found as described below.
 +
 
 +
#Login to PayPal
 +
#Go to Profile > API Access
 +
[[File:Pp_api2.png‎|thumb|PayPal API Step 2]]
 +
#Choose '''Option 2''' - Request API credentials to create your own API username and password.
 +
#Choose '''Option 1''' - Request API Signature and click Agree and Submit
 +
#Copy the username, password and signature that get provided and then click Done
 +
#Enter the details from the previous step into the WHMCS Payment Gateways config screen where requested
  
 
===3D Secure===
 
===3D Secure===
  
The next 3 fields: '''Processor ID, Merchant ID & Transaction PW''' are used by the 3D Secure process.  PayPal Pro Accounts are usually enrolled for this by default these days and if you have been enrolled, PayPal will have provided you with the details for it.
+
The next 3 fields in the configuration after API details are: '''Processor ID, Merchant ID & Transaction PW'''.  These are used by the 3D Secure process.  PayPal Pro Accounts are usually enrolled for this by default these days and if you have been enrolled, PayPal will have provided you with the details for it.
  
If they haven't or you don't want to use the 3D Secure feature, then simply leaving these fields blank in WHMCS will mean the 3D Secure process is not used during the checkout process on your site.
+
If they haven't or you don't want to use the 3D Secure feature, then simply leaving these fields blank in WHMCS will disable the 3D Secure process, and mean it is not used during the checkout process on your site.
  
 
===Declined Payments===
 
===Declined Payments===
If you experience an error whilst processing payments navigate to '''Billing > Gateway Log''' and the full response from PayPal is displayed in the debug field. Refer to the L_ERRORCODE0 value, the following two values will then briefly explain the error.
+
 
 +
If you experience an error whilst processing payments navigate to '''Billing > Gateway Log''' and 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.
 +
 
 +
A common error response is: '''L_SHORTMESSAGE0 => Security error'''  This indicates that the API Details you've entered in the Setup > Payment Gateways config area are invalid and need to be double checked.
  
 
More detailed descriptions of the errors and instructions for correcting them can be found at https://cms.paypal.com/uk/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_nvp_errorcodes
 
More detailed descriptions of the errors and instructions for correcting them can be found at https://cms.paypal.com/uk/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_nvp_errorcodes

Revision as of 23:35, 9 October 2011

PayPal Payments Pro, also referred to as Website Payments Pro sometimes, is the Merchant Gateway Solution offering from PayPal. It allows you to process payments direct from clients credit/debit cards to your PayPal account without the customer ever leaving your site.

Configuration

To activate the module, begin by going to Setup > Payment Gateways and choosing "PayPal Website Payments Pro" from the available list of gateways to activate.

API Details

PayPal API Step 1

Once activated, you then need to enter your details for the PayPal Pro API. These can be found as described below.

  1. Login to PayPal
  2. Go to Profile > API Access
PayPal API Step 2
  1. Choose Option 2 - Request API credentials to create your own API username and password.
  2. Choose Option 1 - Request API Signature and click Agree and Submit
  3. Copy the username, password and signature that get provided and then click Done
  4. Enter the details from the previous step into the WHMCS Payment Gateways config screen where requested

3D Secure

The next 3 fields in the configuration after API details are: Processor ID, Merchant ID & Transaction PW. These are used by the 3D Secure process. PayPal Pro Accounts are usually enrolled for this by default these days and if you have been enrolled, PayPal will have provided you with the details for it.

If they haven't or you don't want to use the 3D Secure feature, then simply leaving these fields blank in WHMCS will disable the 3D Secure process, and mean it is not used during the checkout process on your site.

Declined Payments

If you experience an error whilst processing payments navigate to Billing > Gateway Log and 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.

A common error response is: L_SHORTMESSAGE0 => Security error This indicates that the API Details you've entered in the Setup > Payment Gateways config area are invalid and need to be double checked.

More detailed descriptions of the errors and instructions for correcting them can be found at https://cms.paypal.com/uk/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_nvp_errorcodes