Revision as of 15:55, 28 June 2013

Supported Features

Recurring Billing

As of WHMCS V4.5, it is possible to have automated recurring billing agreements created with 2CheckOut from WHMCS. This is done using the 2CheckOut API and so if you wish to use this functionality you will need to enter your API Username & Password in the module config (see below for details).

Module Setup

Notifications

To setup the callback process for 2CheckOut to automatically mark invoices paid, you will need to login to your 2CheckOut account and then go to the Notifications section of your account. There you should see a field for a Global URL. In that field, enter the url http://www.yourdomain.com/whmcs/modules/gateways/callback/tco.php and then click Apply. Also click the Enable All Notifications button and then save to complete.

Direct Return

In order to return clients back to your WHMCS installation after a successful payment you can configure Direct Return within the 2CO control panel. Navigate to Account > Site Management > Direct Return, select the "Direct Return" option and set the URL to http://www.yourdomain.com/whmcs/modules/gateways/callback/2checkout.php

Secret Word

For added security, you can set a "Secret Word" inside your 2CheckOut account @ Account > Site Management. If set, this is then used to validate callbacks are authentic and it is therefore recommended that you do this. If you choose to enable it, then you must also enter the exact same word that you set inside the 2CheckOut control panel into the WHMCS Secret Word field in Setup > Payment Gateways

API Username/Password

If you wish to be able to use the recurring billing and/or automatic refunds functionality within WHMCS, then you must setup a 2CheckOut API user and enter the details in these fields.

To setup an API user, you will need to login to your 2CheckOut account and go to Account > User Management > Create Username. Once there you will be asked to enter an email address, username & password, security question & answer, and then select the permissions for the user. You just need to select API Access & API Updating for the permissions. Once you've done that you would then enter the same username & password that you just created into the appropriate fields inside WHMCS.

Purchase Routine

When unticked the standard spurchase routine will be used. Tick this option to use the more modern purchase checkout process which includes the option for clients to pay via PayPal.

Error Messages

Demo Mode

In order to use demo mode, the "Demo Setting" in your 2CheckOut account should be set to "Parameter" under Account > Site Management. Demo mode can then be enabled by ticking the checkbox in WHMCS under Setup > Payments > Payment Gateways.

Please note that when using 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 those who sell digital goods from fraudulent purchases through their demo mode.

In Demo Mode, valid credit card data must be submitted in order to properly perform the request. Credit cards will not be charged during this process.

MD5 Hash Failure

An MD5 Hash Failure error under Billing > Gateway Log indicates that the Secret Word in Setup > Payment Gateways does not match the Secret Word in the 2CheckOut control panel. Double check your entry is exactly right, and check for any invisible trailing spaces if so.