Difference between revisions of "Payflow Pro"

From WHMCS Documentation

(About this Module)
 
(17 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 Payflow Pro (PayPal) payment gateway module is available in WHMCS.
 
{{gateways
 
{{gateways
 
| type = cc
 
| type = cc
Line 7: Line 16:
 
}}
 
}}
  
===Configuration===
+
== Adding the Payflow Pro (PayPal) Payment Gateway ==
To activate the module, begin by going to '''Setup > Payments > Payment Gateways''' and choosing "Payflow Pro (PayPal)" from the available list of gateways to activate. Complete the first 4 fields using the details provided by PayPal (Partner, Merchant Login, Username, Password) and click Save Changes to start accepting payments.
+
 
+
To set up the Payflow Pro (PayPal) payment gateway in WHMCS:
===3D Secure===
+
 
+
# Go to the appropriate location for your version of WHMCS:
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.
+
#* 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'''.
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.
+
# Click '''Payflow Pro (PayPal)'''.
 
+
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.  
====API Details====
+
# Enter your Payflow Pro (PayPal) credentials.
 
+
#* '''Processor ID''', '''Merchant ID''', and '''Transaction PW''' are used by the 3D Secure process.  
[[File:Pp_api1.png‎|thumb|PayPal API Step 1]]
+
#** PayPal Pro accounts are enrolled for this by default. If you are enrolled, PayPal will provide details.
Once activated, you then need to enter your details for the Payflow Pro API. These can be found as described below.
+
#** 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 your PayPal account.[[File:Paypal_api.png‎|thumb|PayPal API]]
 +
#*# Go to '''Account Setting''' by hovering over your name in the top-right corner.
 +
#*# Click '''Update''' next to '''API Access'''.
 +
#*# Under '''NVP/SOAP API integration''', click '''Manage API credentials'''.
 +
#*# Choose '''Request API signature'''.
 +
#*# Click '''Agree and Submit'''.
 +
# Click '''Save Changes'''.
  
#Login to PayPal
+
=== Test Mode === 
#Go to Profile > My selling preferences > 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
 
  
 +
You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.
  
===Use Reference Transactions===
+
==PayPal Pro 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.
+
<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.
Contrary to what you might think, you should not tick the setting to "Disable Credit Card Storage" in '''Setup > General Settings > Security''' as that will disable entry by a client.
+
</div>
 
+
<div class="docs-alert-info">
 +
For information on all of our PayPal integrations, see [[PayPal]].
 +
</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
 
| level = 4
 
| level = 4
Line 43: Line 58:
 
| 3dsecure = yes
 
| 3dsecure = 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 (<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 PayPal Pro API:
 +
#*# Log in to your PayPal account.[[File:Paypal_api.png‎|thumb|PayPal API]]
 +
#*# Go to '''Account Setting''' by hovering over your name in the top-right corner.
 +
#*# Click '''Update''' next to '''API Access'''.
 +
#*# Under '''NVP/SOAP API integration''', click '''Manage API credentials'''.
 +
#*# Choose '''Request API signature'''.
 +
#*# Click '''Agree and Submit'''.
 +
# Click '''Save Changes'''.
 +
 +
== Troubleshooting ==
 +
 +
===Details could not be saved. Remote storage failed===
 +
 +
This message will display when attempting to create a credit card payment method via the Admin Area or Client Area. Due to restrictions in Payflow's ''Reference Payment'' features, this module does not support remote updating, storage, or deletion of card details.
 +
 +
Clients can specify a new card by viewing an invoice in the Client Area, clicking '''Pay Now''', selecting a new credit card, and providing the card's details.
 +
 +
===No Local Credit Card Payment Gateways Enabled===
 +
 +
You may encounter this error when attempting to make a payment via the Client Area if you have unchecked the option to save card details for later. Due to the reference nature of the gateway, the card details must always be stored at PayPal for automated rebilling of Reference Transactions to function.
  
 +
The client's credit details will never be stored on your server.
  
 
{{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 Payflow Pro (PayPal) payment gateway module is available in WHMCS.

Supported Features

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


Adding the Payflow Pro (PayPal) Payment Gateway

To set up the Payflow Pro (PayPal) 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 Payflow Pro (PayPal).
  3. Check Show on Order Form to display this payment method in the Client Area during checkout.
  4. Enter your Payflow Pro (PayPal) 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 your PayPal account.
        PayPal API
      2. Go to Account Setting by hovering over your name in the top-right corner.
      3. Click Update next to API Access.
      4. Under NVP/SOAP API integration, click Manage API credentials.
      5. Choose Request API signature.
      6. Click Agree and Submit.
  5. 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.

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

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 Yes
Remote Update Card Remote Delete Card AddPayMethod API
No No No

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 PayPal Pro API:
      1. Log in to your PayPal account.
        PayPal API
      2. Go to Account Setting by hovering over your name in the top-right corner.
      3. Click Update next to API Access.
      4. Under NVP/SOAP API integration, click Manage API credentials.
      5. Choose Request API signature.
      6. Click Agree and Submit.
  5. Click Save Changes.

Troubleshooting

Details could not be saved. Remote storage failed

This message will display when attempting to create a credit card payment method via the Admin Area or Client Area. Due to restrictions in Payflow's Reference Payment features, this module does not support remote updating, storage, or deletion of card details.

Clients can specify a new card by viewing an invoice in the Client Area, clicking Pay Now, selecting a new credit card, and providing the card's details.

No Local Credit Card Payment Gateways Enabled

You may encounter this error when attempting to make a payment via the Client Area if you have unchecked the option to save card details for later. Due to the reference nature of the gateway, the card details must always be stored at PayPal for automated rebilling of Reference Transactions to function.

The client's credit details will never be stored on your server.

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