Difference between revisions of "Payment Reversals"

Latest revision as of 16:56, 17 May 2024

This page describes a feature available in WHMCS 7.2 and higher.

What are Payment Reversals?

Payment reversals return the payment for a transaction to the buyer. This typically happens after a chargeback or having lost a dispute with a customer (for example, a lost PayPal claim). In this situation, it is common to reverse the actions that the transaction triggered when it was originally received. The Payment Reversals feature in WHMCS automates this for you.

WHMCS 8.3 and higher includes support for disputes for Stripe (credit card only) and some PayPal® transactions at Billing > Disputes.
For more information on working with disputes in WHMCS 8.2 and earlier, see Transactions.

Supported Gateways

WHMCS can automatically perform payment reversals for the following supported payment gateways when they notify WHMCS of a reversal:

Reversal Actions

Reversals can include the following actions:

Change Invoice Status — This action sets the invoice to the Collections status. This status can help you track invoices that have a problematic payment history (for example, invoices that have received chargebacks, disputes, sold or unpaid debts, or other lost business).
Change Due Dates — This action reverts Next Due Date increments for the products and services in an invoice. This marks the item as due or, in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment.

Enabling Automated Payment Reversals

To enable automated payment reversals, go to Configuration () > System Settings > Automation Settings or, prior to WHMCS 8.0, Setup > Automation Settings.

Make certain that you check both Change Invoice Status and Change Due Dates.

Email Notifications

When a payment reversal notification is received, WHMCS will send an email notification to all admins whose role group receives Account Emails. For more information, see Managing Administrator Roles.

Making a Manual Payment Reversal

A manual payment reversal can be performed when adding a refund to an invoice. To do this, check Reverse Payment when making the refund. The invoice status and next due dates will be reversed as appropriate.

In WHMCS 8.3 and higher, when you perform a manual refund on an applicable transaction, you may also reverse any affiliate commissions. For more information, see Invoicing and Affiliates.

Reversal Actions for Given Items

Reversal actions can vary depending on the products and services for an invoice:

Hosting and Hosting Addons Invoice

Any hosting and hosting addons that are part of the invoice for the reversed transaction will have their next due dates automatically reverted. If the payment reversal occurs as part of the cron tasks, automatic suspension, if enabled, will occur next. If the reversal is standalone, any potential suspension will run with the next scheduled automatic suspension.

Domain Items: You must manage domain items manually. Payment reversals do not trigger any automatic actions for domains.

Upgrade Invoice

WHMCS will immediately suspend any services associated with the upgrade.

Add Funds Invoice

WHMCS will immediately remove the credit from the client account. This could result in a negative credit balance.

Mass Payment Invoice

A reversed transaction will apply to each paid invoice and those invoices will go to the Collections status.

Prorated Hosting and Hosting Addons: The next due date of the items on the invoice will be set to the previous due date.; If the payment reversal occurs as part of the cron tasks and automatic suspensions are enabled, suspension may occur.; If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.

Custom Items

Nothing can occur with custom invoice items. There is no relationship to use in WHMCS.

@@ Line 1: / Line 1: @@
-<div class="docs-alert-info"><i class="fa fa-question-circle"></i> This page describes a feature available in version 7.2 and above</div>
+<div class="docs-alert-info">
+<i class="fa fa-question-circle"></i>
+This page describes a feature available in WHMCS 7.2 and higher.
+</div>
 ==What are Payment Reversals?==
-A payment reversal is when a transaction paid to you is returned to the buyer, typically via a payment dispute or chargeback.
+Payment reversals return the payment for a transaction to the buyer. This typically happens after a chargeback or having lost a [[Disputes|dispute]] with a customer (for example, a lost PayPal claim). In this situation, it is common to reverse the actions that the transaction triggered when it was originally received. The Payment Reversals feature in WHMCS automates this for you.
+<div class="docs-alert-info">
+* WHMCS 8.3 and higher includes support for disputes for [[Stripe]] (credit card only) and some [[PayPal]]® transactions at '''Billing > [[Disputes]]'''.
+* For more information on working with disputes in WHMCS 8.2 and earlier, see [[Transactions]].
+</div>
-In this situation, it is common to want to reverse the actions that a transaction triggered when it was originally received. This is what the Payment Reversals feature in WHMCS can automate for you.
+=== Supported Gateways ===
-==What does it do?==
+WHMCS can automatically perform payment reversals for the following supported payment gateways when they notify WHMCS of a reversal:
-For supported gateways, WHMCS can automatically reverse a payment when a notification is received from a payment gateway about a reversal.
+* [[GoCardless]]
+* [[PayPal Basic]]®
+* [[SlimPay]]
+* [[Skrill]]
-Supported reversal actions include:
+=== Reversal Actions ===
-* '''Change Invoice Status''' - Set Invoice to Collections Status.  The collections status for invoices in WHMCS is used to denote an invoice which is a bad debt and can be used to track invoices which have received payment disputes or chargebacks.
+Reversals can include the following actions:
-* '''Change Due Dates''' - Reverts Next Due Date Increments for the products and services contained within an invoice. This has the effect of making the item be considered due again, and in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment is made.
-==Enabling Automated Payment Reversals==
+* '''Change Invoice Status''' — This action sets the invoice to the '''Collections''' status. This status can help you track invoices that have a problematic payment history (for example, invoices that have received chargebacks, [[disputes]], sold or unpaid debts, or other lost business).
+* '''Change Due Dates''' — This action reverts '''Next Due Date''' increments for the products and services in an invoice. This marks the item as due or, in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment.
-To enable Automated Payment Reversal handling, navigate to Setup > Automation Settings and ensure the checkboxes are ticked for the '''Change Invoice Status''' and '''Change Due Dates''' settings.
+== Enabling Automated Payment Reversals ==
+To enable automated payment reversals, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
+Make certain that you check both '''Change Invoice Status''' and '''Change Due Dates'''.
 ==Email Notifications==
-When a payment reversal notification is received, WHMCS will send an email notification to all admin users with a role group that is set to receive "Account Emails".  See [[Administrators_and_Permissions#Managing_Administrator_Roles|Managing Administrator Roles]] for more information.
+When a payment reversal notification is received, WHMCS will send an email notification to all admins whose role group receives '''Account Emails'''. For more information, see [[Administrators_and_Permissions#Managing_Administrator_Roles|Managing Administrator Roles]].
 ==Making a Manual Payment Reversal==
@@ Line 27: / Line 43: @@
 [[File:payment_reversal.png|750px]]
-A manual payment reversal can be performed when adding a refund to an invoice.
+A manual payment reversal can be performed when adding a refund to an invoice. To do this, check '''Reverse Payment''' when making the refund. The invoice status and next due dates will be reversed as appropriate.
-Simply check the '''Reverse Payment''' when making the refund and the invoice status and next due dates will be reversed as appropriate.
+<div class="docs-alert-info">
+<i class="fa fa-question-circle"></i>
+In WHMCS 8.3 and higher, when you perform a manual refund on an applicable transaction, you may also reverse any affiliate commissions. For more information, see [[Invoicing]] and [[Affiliates]].
+</div>
 ==Reversal Actions for Given Items==
-The reversal actions performed can vary depending upon the products/services contained with an invoice as follows.
+Reversal actions can vary depending on the products and services for an invoice:
-;Hosting & Hosting Addons Invoice
+;Hosting and Hosting Addons Invoice
-: Any hosting and hosting addons that are part of the invoice for the reversed transaction will have their next due dates automatically reverted.
+: Any hosting and hosting addons that are part of the invoice for the reversed transaction will have their next due dates automatically reverted. If the payment reversal occurs as part of the cron tasks, automatic suspension, if enabled, will occur next. If the reversal is standalone, any potential suspension will run with the next scheduled automatic suspension.
-:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, will occur next.
-:If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.
 ;Domain Items
-:Domain items will need to be manually managed. There is no automatic action taken with domains when a Payment Reversal occurs.
+:You must manage domain items manually. Payment reversals do not trigger any automatic actions for domains.
 ;Upgrade Invoice
-:The service associated with the upgrade will be immediately suspended.
+:WHMCS will immediately suspend any services associated with the upgrade.
 ;Add Funds Invoice
-:The credit applied to the client account will be immediately removed. This could leave a client with a negative credit balance.
+:WHMCS will immediately remove the credit from the client account. This could result in a negative credit balance.
 ;Mass Payment Invoice
-:Each invoice that has been paid will have a reversed transaction applied to it and the invoice will be set to Collections.
+:A reversed transaction will apply to each paid invoice and those invoices will go to the '''Collections''' status.
-;ProRated Hosting & Hosting Addons
+;Prorated Hosting and Hosting Addons
 :The next due date of the items on the invoice will be set to the previous due date.
-:If the payment reversal occurs as part of the cron, automatic suspend, if enabled, may occur next.
+:If the payment reversal occurs as part of the cron tasks and automatic suspensions are enabled, suspension may occur.
 :If the reversal is standalone, any potential suspend will run when the automatic suspension tasks is next scheduled.
 ;Custom Items
-:Nothing can occur with custom invoice items. There is no relationship in WHMCS that can be utilised.
+:Nothing can occur with custom invoice items. There is no relationship to use in WHMCS.

Documentation