Difference between revisions of "PayPal Checkout Migration Guide"

From WHMCS Documentation

(→‎Step 2: Hide the PayPal Basic module)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
PayPal Checkout is the latest and recommended PayPal integration to use for anybody wanting to accept payments by PayPal.
+
PayPal Checkout is the latest and recommended PayPal integration to use for accepting payments by PayPal.  
  
−
To learn more about PayPal Checkout and the integration features, please see the [[PayPal Checkout]] documentation.
+
If you have used the previous PayPal module for automated recurring PayPal subscriptions, we recommend migrating to the newer PayPal Checkout module. If you have not used the previous module, you do not need to perform these migration steps and can go immediately to the new PayPal Checkout module.
  
−
==Who this guide applies to==
+
To learn more about PayPal Checkout and the integration features, see [[PayPal Checkout]].
  
−
The following guide applies to users of WHMCS who have used the previous PayPal module in WHMCS for automated recurring PayPal subscriptions.
+
==Step 1: Activate the PayPal Checkout module==
 +
 +
To activate the PayPal Checkout module:
 +
 +
# Find the '''PayPal Checkout''' module in the list of available payment gateways:
 +
#* In WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''.
 +
#* In WHMCS 8.0 through 8.5, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
 +
#* Prior to WHMCS 8.0, go to '''Setup > Payment Gateways'''.
 +
# Click the PayPal banner or, in WHMCS 8.5 and later, click '''Activate & Configure'''.
 +
# Follow the instructions to sign in to your PayPal account in order to link it with your WHMCS installation.
  
−
It contains important information about how you can migrate to the newer PayPal Checkout module.
+
==Step 2: Hide the PayPal Basic module==
  
−
If you are new to WHMCS, or have not used the PayPal Subscription functionality available in prior PayPal integrations, then this guide does not apply to you. You may activate the new "PayPal Checkout" module and/or deactivate the prior "PayPal Basic" module without issue.
+
The PayPal Checkout module is not a direct replacement for the previous PayPal module.
  
−
== Migration Guide==
+
If you set up PayPal subscriptions via the previous PayPal integration ('''[[PayPal Basic]]''') or via a custom or third-party PayPal integration, '''do not deactivate''' the '''PayPal Basic''' module. The '''PayPal Basic''' module must be kept active for WHMCS to continue recognizing and applying recurring payments.[[File:Paypal_hide_order_form.png|thumb|Uncheck Show on Order Form]]
−
 
 
−
===Step 1: Activate the new PayPal Checkout module===
 
−
 
 
−
Begin by activating the new PayPal Checkout integration.
 
−
 
 
−
To do this, navigate to Setup > Payment Gateways and click the Activate & Configure button under the PayPal banner.
 
−
 
 
−
A popup will open prompting you to sign in to your PayPal account in order to link it to your WHMCS installation and automatically configure the new module.  Complete the process as provided by PayPal to link your PayPal account.
 
−
 
 
−
===Step 2: Hide the PayPal Basic module===
 
−
 
 
−
The new PayPal Checkout module is not a direct replacement for the PayPal module that existed before it.
 
−
 
 
−
If you have PayPal Subscriptions that were setup either via the previous official PayPal integration from WHMCS (now known as "PayPal Basic"), or via a custom or 3rd party PayPal integration that were later migrated to WHMCS, it is important that you '''do not deactivate''' the "PayPal Basic" module. The PayPal Basic module must be kept active in order for recurring payments made via these subscriptions to continue to be recognised and applied automatically.
 
−
[[File:Paypal_hide_order_form.png|thumb|Uncheck Show on Order Form]]
 
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payment Gateways'''.
 
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payment Gateways'''.
−
# Locate the PayPal Basic module.
+
# Locate the '''PayPal Basic''' module.
−
# Uncheck the "Show on Order Form" checkbox.
+
# Uncheck the '''Show on Order Form''' checkbox.
−
# Click Save Changes.
+
# Click '''Save Changes'''.
  
−
This will stop the PayPal Basic module from showing in the list of available payment methods both during checkout as well as via the Payment Method selection dropdown on invoices (if enabled).
+
This will stop the '''PayPal Basic''' module from showing in the list of available payment methods both during checkout as well as via the '''Payment Method''' selection menu on invoices (if you have enabled it).
  
−
===Step 3: Migrating existing products/services===
+
==Step 3: Migrating existing products/services==
  
−
In order to have existing products/services benefit from the new features and functionality of the PayPal Checkout module, it is necessary to change their default payment method to the new module.
+
In order to have existing products and services benefit from the new features and functionality of the '''PayPal Checkout''' module, it is necessary to change their default payment method to the new module.
  
 
This can be done on an individual basis, or can be done in bulk by executing the following queries against your WHMCS database:
 
This can be done on an individual basis, or can be done in bulk by executing the following queries against your WHMCS database:
Line 47: Line 41:
 
</div>
 
</div>
  
−
This will update all products, services, addons, domains and draft/unpaid invoices to use the new PayPal Checkout integration to allow users to benefit from the optimised checkout workflow and subscription information procedure.
+
This will update all products, services, addons, domains, and draft or unpaid invoices to use the new '''PayPal Checkout''' integration.
  
−
The PayPal Basic module will remain active to be able to continue to receive and handle IPN notification of payments appropriately.
+
The PayPal Basic module will remain active to receive and handle IPN notification of payments appropriately.

Latest revision as of 16:06, 7 September 2022

PayPal Checkout is the latest and recommended PayPal integration to use for accepting payments by PayPal.

If you have used the previous PayPal module for automated recurring PayPal subscriptions, we recommend migrating to the newer PayPal Checkout module. If you have not used the previous module, you do not need to perform these migration steps and can go immediately to the new PayPal Checkout module.

To learn more about PayPal Checkout and the integration features, see PayPal Checkout.

Step 1: Activate the PayPal Checkout module

To activate the PayPal Checkout module:

  1. Find the PayPal Checkout module in the list of available payment gateways:
    • In WHMCS 8.6 and later, go to Configuration () > Apps & Integrations.
    • In WHMCS 8.0 through 8.5, go to Configuration () > System Settings > Payment Gateways.
    • Prior to WHMCS 8.0, go to Setup > Payment Gateways.
  2. Click the PayPal banner or, in WHMCS 8.5 and later, click Activate & Configure.
  3. Follow the instructions to sign in to your PayPal account in order to link it with your WHMCS installation.

Step 2: Hide the PayPal Basic module

The PayPal Checkout module is not a direct replacement for the previous PayPal module.

If you set up PayPal subscriptions via the previous PayPal integration (PayPal Basic) or via a custom or third-party PayPal integration, do not deactivate the PayPal Basic module. The PayPal Basic module must be kept active for WHMCS to continue recognizing and applying recurring payments.
Uncheck Show on Order Form
  1. Navigate to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payment Gateways.
  2. Locate the PayPal Basic module.
  3. Uncheck the Show on Order Form checkbox.
  4. Click Save Changes.

This will stop the PayPal Basic module from showing in the list of available payment methods both during checkout as well as via the Payment Method selection menu on invoices (if you have enabled it).

Step 3: Migrating existing products/services

In order to have existing products and services benefit from the new features and functionality of the PayPal Checkout module, it is necessary to change their default payment method to the new module.

This can be done on an individual basis, or can be done in bulk by executing the following queries against your WHMCS database:

UPDATE tblhosting SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tblhostingaddons SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tbldomains SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal';
UPDATE tblinvoices SET paymentmethod='paypalcheckout' WHERE paymentmethod='paypal' AND status IN ('Draft','Unpaid');

This will update all products, services, addons, domains, and draft or unpaid invoices to use the new PayPal Checkout integration.

The PayPal Basic module will remain active to receive and handle IPN notification of payments appropriately.

Retrieved from "http://3.17.75.209/index.php?title=PayPal_Checkout_Migration_Guide&oldid=33355"