Difference between revisions of "Migrating Payment Gateways"

Latest revision as of 17:41, 9 December 2022

When you change your setup from using one payment gateway to using another, we recommend the process below.

Migrate Payment Gateways

The steps to migrate payment gateways depend on your version of WHMCS.

Migrate in WHMCS 8.6 and Later

To migrate from one payment gateway to another:

Go to Configuration () > Apps & Integrations
Click on the new payment gateway.
Click Activate. The system will redirect you to Configuration () > System Settings > Payment Gateways.
Configure the new payment gateway.
Click Deactivate to deactivate the old module. The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to.
Select the new payment gateway.
If you are moving to a tokenization gateway and you store card details or tokens for any clients, you may wish to delete them by clicking Credit Card Information in the client's profile's Summary tab.

Migrate in WHMCS 8.5 and earlier

To migrate from one payment gateway to another:

Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.
Click Activate for the desired payment gateway.
Deactivate the old module by clicking Deactivate. The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to.
Select the new payment gateway.
If you are moving to a tokenization gateway and you store card details or tokens for any clients, you may wish to delete them by clicking Credit Card Information in the client's profile's Summary tab.

Additional Client Actions

Depending on the type of payment gateway module you're switching to, you or your clients may need to perform additional actions:

If you are switching between merchant gateways or third-party gateway modules, there are no additional steps and you are finished.
If you are switching to a merchant gateway for the first time, clients will need to enter their card details at Hello, Name! > My Details in the Client Area. The system will charge the card when the next invoice is due.
If you are switching between tokenization modules, clients will need to pay the first invoice manually, which will store their card details on your processor's servers. The system will attempt subsequent payments automatically.
This type of migration requires the client's intervention because the system requires their CVV number for the first payment.
If you are switching from a merchant gateway to a tokenization gateway, clients will usually need to manually pay their next invoice in the Client Area.
If you are switching from a merchant or tokenization gateway to a third party gateway, clients will need to manually pay their next invoice in the Client Area.

@@ Line 1: / Line 1: @@
-Sometimes, you may want to stop using one payment gateway and switch to another.
+When you change your setup from using one payment gateway to using another, we recommend the process below.
 ==Migrate Payment Gateways==
+The steps to migrate payment gateways depend on your version of WHMCS.
+=== Migrate in WHMCS 8.6 and Later ===
+To migrate from one payment gateway to another:
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''
+# Click on the new payment gateway.
+# Click '''Activate'''. The system will redirect you to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]'''.
+# Configure the new payment gateway.
+# Click '''Deactivate''' to [[Payment_Gateways#Deactivating_Gateway_Modules|deactivate the old module]]. The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to.
+# Select the new payment gateway.
+# If you are moving to a tokenization gateway and you store card details or tokens for any clients, you may wish to delete them by clicking '''Credit Card Information''' in the client's profile's '''[[Clients:Summary Tab|Summary]]''' tab.
+=== Migrate in WHMCS 8.5 and earlier ===
+To migrate from one payment gateway to another:
+# Go 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'''.
+# Click '''Activate''' for the desired payment gateway.
+# [[Payment_Gateways#Deactivating_Gateway_Modules|Deactivate]] the old module by clicking '''Deactivate'''. The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to.
+# Select the new payment gateway.
+# If you are moving to a tokenization gateway and you store card details or tokens for any clients, you may wish to delete them by clicking '''Credit Card Information''' in the client's profile's '''[[Clients:Summary Tab|Summary]]''' tab.
-To do this:
+=== Additional Client Actions ===
-# Enable and configure the new payment gateway module under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
+Depending on the type of payment gateway module you're switching to, you or your clients may need to perform additional actions:
-# [[Payment_Gateways#Deactivating_Gateway_Modules|Deactivate]] the old module by clicking '''Deactivate'''. The system will prompt you to choose the payment gateway you wish to reassign all existing services and invoices to.
-# Select the new payment gateway.
+* If you are switching between merchant gateways or third-party gateway modules, there are no additional steps and you are finished.
-# Depending upon the type of payment gateway module you're switching to, perform one of the following steps:
+* If you are switching to a merchant gateway for the first time, clients will need to enter their card details at '''Hello, Name! > My Details''' in the Client Area. The system will charge the card when the next invoice is due.
-## If you are switching between merchant gateways or third-party gateway modules, there is no third step and you are finished.
+* If you are switching between tokenization modules, clients will need to pay the first invoice manually, which will store their card details on your processor's servers. The system will attempt subsequent payments automatically. <div class="docs-alert-warning">This type of migration '''requires''' the client's intervention because the system requires their CVV number for the first payment.</div>
-## If you are switching to a merchant gateway for the first time, the client will need to log in and enter their card details to the '''My Details''' page in the client area. The system will charge the card when the next invoice is due.
+* If you are switching from a merchant gateway to a tokenization gateway, clients will usually need to manually pay their next invoice in the Client Area.
-## If you are switching between tokenisation modules, the client will need to log in and pay their first invoice manually, which will store their card details on your processor's servers. The system will attempt subsequent payments automatically. Regrettably, there isn't a way for the migration to be done without client's intervention because the system requires their CVV number for the first payment.
+* If you are switching from a merchant or tokenization gateway to a third party gateway, clients will need to manually pay their next invoice in the Client Area.
-## If you are switching from a merchant gateway to a tokenization gateway, typically clients will need to manually pay their next invoice via the client area.  If you store card details or a token for the client, you may wish to delete them via the "Credit Card Information" link on each client's summary page beforehand.
-## If you are switching from a merchant or tokenization gateway to a third party gateway, clients will need to manually pay their next invoice via the client area. If you store card details or a token for the client, you may wish to delete them via the '''Credit Card Information''' link in each client's '''[[Clients:Summary Tab|Summary]]''' tab beforehand.

Documentation