Migrating Payment Gateways

From WHMCS Documentation

Revision as of 17:41, 9 December 2022 by SarahK (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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:

  1. Go to Configuration () > Apps & Integrations
  2. Click on the new payment gateway.
  3. Click Activate. The system will redirect you to Configuration () > System Settings > Payment Gateways.
  4. Configure the new payment gateway.
  5. 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.
  6. Select the new payment gateway.
  7. 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:

  1. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.
  2. Click Activate for the desired payment gateway.
  3. 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.
  4. Select the new payment gateway.
  5. 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.