Difference between revisions of "Pay Methods"

From WHMCS Documentation

(Managing Pay Methods)
Line 1: Line 1:
==Introduction==
+
In WHMCS, a Pay Method is a method of payment that belongs to a client. A Pay Method can represent a credit card or a bank account.
  
In WHMCS, a Pay Method is a method of payment belonging to a client. A Pay Method can represent a credit card or a bank account and a client can have multiple Pay Methods associated with their account.
+
Clients can choose any of their available Pay Methods during checkout for new orders and for payment of invoices. Each Pay Method can also have a different associated billing address.
 
 
Clients can choose any of their available Pay Methods during checkout both for new orders and payment of invoices.
 
 
 
Each Pay Method can also have a different billing address associated with it if required.
 
  
 
==Default Pay Method==
 
==Default Pay Method==
  
There must always be a default Pay Method and this is the Pay Method that is used by default for all automatic recurring payment attempts.
+
Clients must always have a default Pay Method. This is the Pay Method that all automatic recurring payment attempts use by default.
  
In certain conditions, the default Pay Method may not be applicable for a given invoice, for example when the default Pay Method is tokenized with a specific payment gateway and the invoice's payment method is a different gateway. In this scenario, the first applicable Pay Method for the user in order of display is used.
+
In certain conditions, the default Pay Method may not be usable for a given invoice (for example, when the default Pay Method is tokenized with a specific payment gateway and the invoice's payment method is a different gateway). If this occurs, the system uses the first applicable Pay Method for the user in the displayed order.
  
<div class="docs-alert-info">'''Please Note:''' At this time, it is not possible to set a different default Pay Method on a per service basis, although this functionality is planned to be delivered in a future update.</div>
+
<div class="docs-alert-info">
 +
You cannot set a different default Pay Method on a per-service basis.
 +
</div>
  
 
==Managing Pay Methods==
 
==Managing Pay Methods==
Line 25: Line 23:
 
===Client Area===
 
===Client Area===
  
Clients can view and manage Pay Methods via the "Payment Methods" page accessible from the Billing and Account sub-menus within the Client Area.
+
Clients can view and manage Pay Methods at '''Billing > Payment Methods''' in the Client Area.
  
 
[[File:payment-methods.png]]
 
[[File:payment-methods.png]]
  
Clients can view all of their saved Pay Methods, edit (update descriptions and expiry date), delete (if enabled) and change the default Pay Method used for automated recurring payment attempts.
+
Clients can view all of their saved Pay Methods, update their descriptions and expiry dates, delete them (if you enable this) and change the default Pay Method for automated recurring payment attempts.
  
 
<div class="docs-alert-warning">
 
<div class="docs-alert-warning">
Line 37: Line 35:
 
==Processing Payments==
 
==Processing Payments==
  
Automated recurring charges will be attempted for capture automatically using the default Pay Method for a given client.
+
The system will attempt automated recurring charges for capture automatically using the default Pay Method for a given client.
  
If no Pay Methods exist for a client, the client will receive an email informing them that an automated payment could not be attempted and that they must login and pay the invoice manually.
+
If no Pay Methods exist for a client, the client will receive an email informing them that the system could not attempt an automated payment and that they must log in and pay the invoice manually.
  
To use a different card, client can login and pay an unpaid invoice manually at any time via the Client Area.
+
To use a different card, clients can log in and pay an unpaid invoice manually at any time via the Client Area.
  
Admin Area users can also attempt a capture at any time using any stored Pay Method. To do this, navigate to the desired invoice within the Admin Area and click the Attempt Capture button. ''If this button does not appear or is disabled, check the Payment Method that the invoice is assigned to via the Options tab.''
+
Admins can also attempt to capture payment at any time using any stored Pay Method. To do this:
  
Upon clicking the Attempt Capture button, a popup window will appear allowing you to choose the desired Pay Method to be used. Select the desired entry, optionally enter the CVV number for the card if available, and then click the Attempt Capture button to attempt the payment.
+
# Go to the desired invoice in the [[Admin Area]].
 +
# Click '''Attempt Capture'''. If '''Attempt Capture''' does not appear or is disabled, check the invoice's assigned Payment Method in the '''Options''' tab.
 +
# Choose the desired Pay Method to use.  
 +
# Optionally, enter the CVV number for the card.
 +
# Click '''Attempt Capture''' to attempt the payment.
  
 
==Related Settings==
 
==Related Settings==

Revision as of 21:13, 28 April 2022

In WHMCS, a Pay Method is a method of payment that belongs to a client. A Pay Method can represent a credit card or a bank account.

Clients can choose any of their available Pay Methods during checkout for new orders and for payment of invoices. Each Pay Method can also have a different associated billing address.

Default Pay Method

Clients must always have a default Pay Method. This is the Pay Method that all automatic recurring payment attempts use by default.

In certain conditions, the default Pay Method may not be usable for a given invoice (for example, when the default Pay Method is tokenized with a specific payment gateway and the invoice's payment method is a different gateway). If this occurs, the system uses the first applicable Pay Method for the user in the displayed order.

You cannot set a different default Pay Method on a per-service basis.

Managing Pay Methods

Admin Area

You can manage client pay methods from the Summary tab of the client profile.

Paymethod-admin-area-v3.png

Client Area

Clients can view and manage Pay Methods at Billing > Payment Methods in the Client Area.

Payment-methods.png

Clients can view all of their saved Pay Methods, update their descriptions and expiry dates, delete them (if you enable this) and change the default Pay Method for automated recurring payment attempts.

If you use a mix of both tokenized and non-tokenized payment gateways, customers can choose the desired payment method when adding one via the Client Area. This determines whether to store the card locally encrypted in the WHMCS database or remotely with the tokenized payment gateway.

Processing Payments

The system will attempt automated recurring charges for capture automatically using the default Pay Method for a given client.

If no Pay Methods exist for a client, the client will receive an email informing them that the system could not attempt an automated payment and that they must log in and pay the invoice manually.

To use a different card, clients can log in and pay an unpaid invoice manually at any time via the Client Area.

Admins can also attempt to capture payment at any time using any stored Pay Method. To do this:

  1. Go to the desired invoice in the Admin Area.
  2. Click Attempt Capture. If Attempt Capture does not appear or is disabled, check the invoice's assigned Payment Method in the Options tab.
  3. Choose the desired Pay Method to use.
  4. Optionally, enter the CVV number for the card.
  5. Click Attempt Capture to attempt the payment.

Related Settings

The Allow Client Pay Method Removal, Delete Encrypted Credit Card Data, and Delete Encrypted Bank Account Data settings affect the behaviour of Pay Method functionality.

You can configure these settings in the Security tab at Configuration () > System Settings > General Settings or, prior to WHMCS 8.0, Setup > General Settings.