From WHMCS Documentation

Revision as of 08:28, 1 October 2015 by John (talk | contribs) (Error Messages)

Supported Features

Type One Time Recurring Refunds Reversals
3rd Party Yes Yes Yes



Begin by activating the payment gateway under Setup > Payments > Payment Gateways and choose 2CheckOut from the Available Gateways dropdown.

Once activated, you can then enter the configuration details explained below. By default clients can chose between one-time and subscriptions payments and enter their own billing details on the 2Checkout site, the following options allow this behaviour to be changed.


2CO Notifications Setup

To setup the callback process for 2CheckOut to automatically mark invoices paid, you will need to login to your 2CheckOut account and click the Notifications tab:

Direct Return

2CO Direct Return Setup

In order to return clients back to your WHMCS installation after a successful payment you can configure Direct Return within the 2CO control panel:

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 > Payments > Payment Gateways

API Username/Password

2CO API User Setup

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

  • Click Create Username
  • Enter an email address, username & password, security question & answer.
  • Select the permissions for the user. You just need to select API Access & API Updating for the permissions.
  • Enter the same username & password that you just created into the appropriate API username and API password fields inside WHMCS.

Disable Recurring

When ticked clients will only be able to make one-time payments (subscriptions disabled). For recurring services they will be required to login and pay each invoice.

Force Recurring

When enabled clients will only be able to make recurring payments when applicable (one-time payments disabled). This means future payments will be sent automatically without the need for manual intervention.

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.

Skip 2CO Fraud Check

Ticking this option will prevent 2Checkout from performing their fraud checks on payments. It can result in faster processing of payments, but may potentially increase your exposure to fraudulent orders and charge-backs.

Should a payment that has been recorded in WHMCS later be determined to be fraudulent, manual action would be required to reverse the payment recorded in WHMCS and suspend any services as appropriate.

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 > Payments > 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.

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 Setup > Payments > Payment Gateways. For further information on this configuration see above.

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin - VePortal
Lxadmin - Virtualmin Pro - XPanel - HyperVM - FluidVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CamTech - CashU - CC Avenue - ChronoPay
Cyberbit - Direct Debit - EEECurrency - E-Gold - EMatters - E-Path - eProcessingNetwork
eWAY Tokens - F2B - FastHosts - Finansbank - GarantiBank - Gate2Shop - LinkPoint
IMSP - Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment
Merchant Partners - Merchant Warrior - IDEALMollie - Moneris - Moneris Vault
Skrill - SlimPay - My iDEAL - NaviGate - NETbilling - Netregistry Pay - NoChex - NTPNow
Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - Paymex - PayPal - PayPal Express Checkout - PayPal Payments Pro
PayPoint.net (SecPay) - Payson - Payza - Planet Authorize - SagePay - ProtX VSP Form - PSIGate
Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens - SecPay - SecurePay - SecurePay AU
Secure Trading - StormPay - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible