Difference between revisions of "PayPal Website Payments Pro"

From WHMCS Documentation
(→‎About this Module)
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
<div class="docs-alert-success">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.</div>
 +
 +
<div class="docs-alert-info">
 +
For information on all of our PayPal integrations, see [[PayPal]].
 +
</div>
 +
 +
The PayPal Website Payments Pro payment gateway module is available in WHMCS.
 
{{gateways
 
{{gateways
 
| type = cc
 
| type = cc
Line 7: Line 16:
 
}}
 
}}
  
−
==Configuration==
+
== Adding the PayPal Website Payments Pro Payment Gateway==
−
To activate the module, begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. Choose "PayPal Website Payments Pro" from the available list of gateways to activate. Complete the first 3 fields using the details provided by PayPal ('''API Username, API Password, and API Signature''') and click Save Changes to start accepting payments.
 
−
 
 
−
===3D Secure===
 
−
 
 
−
The next 3 fields in the configuration 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.
+
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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|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: [[File:PayPal_API_Access1.png‎|thumb|PayPal API Step 2]]
 +
## Log in to PayPal.[[File:PayPal_API_Access2.png‎|thumb|PayPal API Step 2]]
 +
## Select your name and company at the top right.
 +
## From the menu, select '''Account settings'''.
 +
## Scroll down and select '''Website payments'''.
 +
## Select '''Update''' for '''API Access'''.
 +
## Under '''NVP/SOAP API integration (classic)''', select '''Manage API credentials'''.
 +
## 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'''.
  
−
===API Details===
+
=== Test Mode ===
−
[[File:PayPal_API_Access1.png‎|thumb|PayPal API Step 2]]
 
−
Once activated, you then need to enter your details for the Payflow Pro API. These can be found as described below.
 
−
[[File:PayPal_API_Access2.png‎|thumb|PayPal API Step 2]]
 
−
#Login to PayPal
 
−
#Select your name/company at the top right
 
−
#On the dropdown menu select "Account settings"
 
−
#On the left, scroll down and select "Website payments"
 
−
#Select "Update" next to "API Access"
 
−
#Under "NVP/SOAP API integration (classic)" select "Manage API credentials"
 
−
#Copy the API credentials
 
  
−
<br/>
+
You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.
−
 
 
−
<br/>
 
−
==Reference Payments==
 
−
This feature helps reduce your PCI compliance liability. Instead of storing card details in the WHMCS database the ID of the last transaction is used to make repeat charges. The limitation with remote card number storage is that changing payment gateway would require clients to re-enter their card details.
 
−
 
 
−
Contrary to what you might think, you should not tick the setting to "Disable Credit Card Storage" in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security'''. This will disable entry by a client.
 
  
 +
==PayPal Pro Reference Payments==
 +
<div class="docs-alert-warning">
 +
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.
 +
</div>
 +
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.
 
{{gateways
 
{{gateways
 
| type = token
 
| type = token
Line 42: Line 54:
 
| refunds = yes
 
| refunds = yes
 
| level = 3
 
| level = 3
 +
| addpaymethod = yes
 
}}
 
}}
  
−
===Limitations===
+
=== Adding the PayPal Pro Reference Payments Payment Gateway ===
−
PayPal applies a time limit on how long you can repeat against a transaction, so 24 months after the original payment you will see a '''Referenced transaction or order is too old''' error.
+
−
The solution is for a client to login and submit payment manually which will generate a new transaction that further repeats can be made against. Any time a client pays manually via the client area, that will be 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.
+
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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|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:
 +
#*# Log in to PayPal.
 +
#*# Go to '''Profile > My selling preferences > API Access'''. [[File:Pp_api2.png‎|thumb|PayPal API Step 2]]
 +
#*# Choose '''Option 2''' to request API credentials to create your own API username and password.
 +
#*# Choose '''Request API signature'''.
 +
#*# Click '''Agree and Submit'''.
 +
#*# Copy the provided username, password, and signature.
 +
#*# 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 <tt>L_ERRORCODE0</tt> value, and the following two values will then briefly explain the error.
  
−
==Declined Payments==
+
<tt>L_SHORTMESSAGE0 => Security error</tt> indicates that the API details you entered at '''Configuration  (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways''' are invalid.
  
−
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.
+
For more detailed descriptions of the errors and instructions for correcting them, [https://developer.paypal.com/api/nvp-soap/errors/ click here].
  
−
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.
+
== Troubleshooting ==
  
−
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
+
''N/A''
  
 
{{modules}}
 
{{modules}}

Latest revision as of 16:04, 6 March 2024

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:

  1. 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.
  2. Click PayPal Website Payments Pro.
  3. Check Show on Order Form to display this payment method in the Client Area during checkout.
  4. 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.
  5. 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.
  6. 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:

  1. 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.
  2. Click PayPal Pro Reference Payments.
  3. Check Show on Order Form to display this payment method in the Client Area during checkout.
  4. 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.
  5. 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.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible


Retrieved from "http://3.17.75.209/index.php?title=PayPal_Website_Payments_Pro&oldid=34453"