Difference between revisions of "2CheckOut"

Latest revision as of 21:49, 26 January 2023

About this Module

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

Supported Features

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

Adding the 2CheckOut Payment Gateway

To set up the 2CheckOut payment gateway in WHMCS:

Go to the appropriate location for your version of WHMCS:
- For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
- For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
Click 2CheckOut.
Check Show on Order Form to display this payment method in the Client Area during checkout.
Optionally, enter a new display name.
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.
Choose your desired checkout style. We recommend always selecting Standard Checkout. For more information, see Checkout Style.
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.
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.
Select a Recurring Billing setting. For more information, see the section below.
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.
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.
Click Save Changes.

Checkout Style

The 2CheckOut module allows you to select between Inline Checkout and Standard Checkout checkout style options. However, 2Checkout has deprecated their legacy inline checkout style and it is no longer available.

2Checkout will use the standard checkout style regardless of your Checkout Style setting.
We recommend always selecting Standard Checkout.
We plan to remove this setting in a future version.

This applies to 2Checkout's legacy inline checkout style and not to their current InLine checkout feature.

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:

Log in to your 2CheckOut account.
Go to the Integrations tab.
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.
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.
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.

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.

Troubleshooting

MD5 Hash Failure

An MD5 Hash Failure error under Billing > Gateway Log indicates that the secret word in Configuration () > 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

Error Code PE101

This error indicates that there are invalid details in the 2CheckOut module settings, such as an incorrect Vendor Account Number value. Ensure that you entered the details correctly in the 2CheckOut gateway configuration.

A PE101 error can also be due to an account-level issue that you must resolve with 2CheckOut:

Account is not approved to sell.
Account has been closed.

It is possible that 2CheckOut is not allowing the use of inline checkout. Changing to standard checkout can resolve this.

Authentication failed

This error at Billing > Gateway Log indicates that the secret word, API username, or API password are incorrect. You can update these at Configuration () > System Settings > Payment Gateways or, prior to WHMCS 8.0, 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
Lxadmin - Virtualmin Pro - XPanel - HyperVM - 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 - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible

@@ Line 1: / Line 1: @@
-==Recurring Billing==
+== About this Module ==
-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).
+The 2CheckOut payment gateway allows you to receive one-time and recurring payments, issue refunds, and other features.
+{{gateways
+| onetime = yes
+| recurring = yes
+| refunds = yes
+| updatecc = yes
+}}
-==Module Setup==
+== Adding the 2CheckOut Payment Gateway==
+To set up the 2CheckOut payment gateway in WHMCS:
+# Go to the appropriate location for your version of WHMCS:
+#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
+#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
+# Click '''2CheckOut'''.
+# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
+# Optionally, enter a new display name.
+# 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.
+# Choose your desired checkout style. We recommend always selecting '''Standard Checkout'''. For more information, see [[#Checkout_Style|Checkout Style]].
+# Enter your API username and password. You can create these in your 2CheckOut account:
+## Go to '''Settings > Manage User Access > View Roles > Add Role''' and enable '''Manage api access'''.
+## Go to '''Settings > Manage User Access > View Users > Add User''' and create a new user with the role you just created.
+# For enhanced security, enter a secret word. You can create the secret word in your 2CheckOut account:
+## In your 2CheckOut account, navigate to "''Integrations''".
+## Copy the '''INS Secret Word''' or generate a new one. The secret word is case-sensitive and can only contain the letters a-z.
+# Select a '''Recurring Billing''' setting. For more information, see the section below.
+# 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.
+# 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'''.
+# Click '''Save Changes'''.
+=== Checkout Style ===
+The '''2CheckOut''' module allows you to select between ''Inline Checkout'' and ''Standard Checkout'' checkout style options. However, 2Checkout has deprecated their legacy inline checkout style and it is no longer available.
-===Notifications===
+* 2Checkout will use the standard checkout style regardless of your '''Checkout Style''' setting.
+* We recommend '''always''' selecting ''Standard Checkout''.
+* We plan to remove this setting in a future version.
+<div class="docs-alert-warning">
+This applies to 2Checkout's legacy inline checkout style and '''not''' to their current [https://www.2checkout.com/lp/inline-cart.html InLine checkout] feature.
+</div>
+=== 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:
+# Log in to your 2CheckOut account.
+# Go to the '''Integrations''' tab.
+# To set the 2CheckOut callback process to automatically mark invoices paid:
+## Check '''Enable INS''' and '''Enable global URL'''.
+## In the '''Global URL''' field, enter <tt>https://www.example.com/whmcs/modules/gateways/callback/tco.php</tt>, where <tt>https://www.example.com/whmcs/</tt> is the URL of your WHMCS installation.
+# To configure Direct Return to return clients to your WHMCS installation after payment:
+## Under '''Redirect URL''' in the '''Approved URL''' field, set the URL to <tt>https://www.example.com/whmcs/modules/gateways/callback/2checkout.php</tt>, where <tt>https://www.example.com/whmcs/</tt> is the URL of your WHMCS installation.
+# 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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > 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.
+<div class="docs-alert-info">
+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.
+</div>
-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.
+==Troubleshooting==
-===Secret Word===
+===MD5 Hash Failure===
-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'''
+An MD5 Hash Failure error under '''Billing > [[Gateway Log]]''' indicates that the secret word in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > 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.
-===API Username/Password===
+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
-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.
+===Error Code PE101===
-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.
+This error indicates that there are invalid details in the 2CheckOut module settings, such as an incorrect '''Vendor Account Number''' value. Ensure that you entered the details correctly in the  [[#Adding_the_2CheckOut_Payment_Gateway|2CheckOut gateway configuration]].
-===Purchase Routine===
+A PE101 error can also be due to an account-level issue that you must resolve with 2CheckOut:
-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.
+* <tt>Account is not approved to sell.</tt>
+* <tt>Account has been closed.</tt>
-==Error Messages==
+It is possible that 2CheckOut is not allowing the use of inline checkout. Changing to [[#Adding_the_2CheckOut_Payment_Gateway|standard checkout]] can resolve this.
-===Test Mode Limitation===
+===Authentication failed===
-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.
+This error at '''Billing > [[Gateway Log]]''' indicates that the secret word, API username, or API password are incorrect. You can update these at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
-===MD5 Hash Failure===
+For further information on this configuration, see above.
-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.
+{{modules}}

Documentation