Revision as of 14:43, 18 April 2022

About this Module

The 2CheckOut payment gateway allows you to receive one-time and recurring payments, issue refunds, and other features.

Supported Features

Adding the 2CheckOut Payment Gateway

To set up the 2CheckOut payment gateway in WHMCS:

1. Go to Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Products/Services > Payment Gateways.
2. Choose the All Payment Gateways tab.
3. Click 2CheckOut.
4. Check Show on Order Form to display this payment method in the Client Area during checkout.
5. Optionally, enter a new display name.
6. Enter your vendor account number. You can find the vendor account number in your 2CheckOut account by clicking the gear icon and copying the Merchant Code value.
7. Choose your desired checkout style. You can choose from the following checkout styles:
   • Inline Checkout — An iframe payment option which displays a secure payment form as an overlay when your client is making payment.
     • This allows for payment to be taken from a client without them leaving your site.
     • WHMCS recommends this checkout style when using 2CheckOut.
   • Standard Checkout — Standard Checkout will redirect a client to the 2CheckOut site to make payment before they are redirected back to your site.
8. Enter your API username and password. You can create these in your 2CheckOut account:
   1. Go to Settings > Manage User Access > View Roles > Add Role and enable Manage api access.
   2. Go to Settings > Manage User Access > View Users > Add User and create a new user with the role you just created.
9. For enhanced security, enter a secret word. You can create the secret word in your 2CheckOut account:
   1. In your 2CheckOut account, navigate to "Integrations".
   2. Copy the INS Secret Word or generate a new one. The secret word is case-sensitive and can only contain the letters a-z.
10. Select a Recurring Billing setting. For more information, see the section below.
11. Check Skip 2CO Fraud Check to prevent 2Checkout from performing their fraud checks on payments. If a payment in WHMCS is later determined to be fraudulent, manual action would be required to reverse the payment in WHMCS and suspend any services.
12. If you use multiple currencies, set Convert To For Processing to the value of the currency your 2Checkout account. For example, if your 2Checkout account is in USD, the Convert To For Processing setting must also be USD.
13. Click Save Changes.

Recurring Billing

When you configure recurring billing, you can select the following options:

• Offer Recurring & One Time Payments — Provide both recurring and one-time billing options.
• Offer Recurring Only — Only provide a recurring option. This option will only appear when there is a recurring item on the invoice and the invoice is not overdue.
• Offer One Time Only — Only provide a one-time option. This option will not allow automatic recurring payments.

If you choose Offer One Time Only, you must configure it in your 2CheckOut account:

1. Log in to your 2CheckOut account.
2. Go to the Integrations tab.
3. To set the 2CheckOut callback process to automatically mark invoices paid:
   1. Check Enable INS and Enable global URL.
   2. In the Global URL field, enter https://www.example.com/whmcs/modules/gateways/callback/tco.php, where https://www.example.com/whmcs/ is the URL of your WHMCS installation.
4. To configure Direct Return to return clients to your WHMCS installation after payment:
   1. Under Redirect URL in the Approved URL field, set the URL to https://www.example.com/whmcs/modules/gateways/callback/2checkout.php, where https://www.example.com/whmcs/ is the URL of your WHMCS installation.
5. Click Update.

Demo Mode

In order to use demo mode, set the Demo Setting in your 2CheckOut account to Parameter under Account > Site Management. Then, in WHMCS, enable demo mode by checking the checkbox at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.

When you use demo mode, all callbacks from 2CheckOut will fail with the error MD5 Hash Failure if a secret word is specified. This is done intentionally by 2Checkout to protect sellers of digital goods from fraudulent purchases through their demo mode.

Troubleshooting

MD5 Hash Failure

An MD5 Hash Failure error under Billing > Gateway Log indicates that the secret word inConfiguration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways does not match the secret word in the 2CheckOut control panel.

To resolve this issue, ensure that the Secret Word in 2Checkout contains only letters and numbers and does not contain any invisible trailing spaces. Then, update the Secret Word value in WHMCS to match the value in your 2Checkout account

Authentication failed

This error in the Gateway Log indicates that either the secret word, API username, or API password are incorrect. These may be reconfigured at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, Setup > Payments > Payment Gateways.

For further information on this configuration, see above.