2CheckOut - Revision history

SarahK: /* Adding the 2CheckOut Payment Gateway */

2023-01-26T21:49:55Z

‎Adding the 2CheckOut Payment Gateway

SarahK: /* Adding the 2CheckOut Payment Gateway */

2022-09-28T19:36:20Z

‎Adding the 2CheckOut Payment Gateway

SarahK at 19:58, 8 September 2022

2022-09-08T19:58:55Z

PeterM: /* Troubleshooting */

2022-09-08T11:06:09Z

‎Troubleshooting

SarahK: /* Adding the 2CheckOut Payment Gateway */

2022-09-07T20:06:09Z

‎Adding the 2CheckOut Payment Gateway

SarahK: /* Troubleshooting */

2022-04-18T14:46:50Z

‎Troubleshooting

SarahK: /* Demo Mode */

2022-04-18T14:43:53Z

‎Demo Mode

SarahK at 20:24, 18 March 2022

2022-03-18T20:24:24Z

Show changes

SarahK at 19:18, 18 January 2022

2022-01-18T19:18:21Z

SarahK at 19:10, 10 September 2021

2021-09-10T19:10:53Z

@@ Line 10: / Line 10: @@
 == 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. You can choose from the following checkout styles:
+# 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'''.
@@ Line 33: / Line 29: @@
 # 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'''.
 === 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.
@@ Line 51: / Line 59: @@
 ## 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.

@@ Line 14: / Line 14: @@
 # Go to the appropriate location for your version of WHMCS:
-#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations'''.
+#* 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 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
+#* 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.

@@ Line 71: / Line 71: @@
 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.
-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
+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 incorrect '''Vendor Account Number''' value.  Ensure that you entered the 2CheckOut correctly in the  [[#Adding_the_2CheckOut_Payment_Gateway|2CheckOut gateway configuration]].
+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]].
-A PE101 error can also be due to an account-level issue that you must resolved with 2CheckOut:
+A PE101 error can also be due to an account-level issue that you must resolve with 2CheckOut:
-* Account is not approved to sell.
+* <tt>Account is not approved to sell.</tt>
-* Account has been closed.
+* <tt>Account has been closed.</tt>
-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.
+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.
 ===Authentication failed===
-This error in the under '''Billing > [[Gateway Log]]''' indicates that either the secret word, API username, or API password are incorrect. These may be reconfigured 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'''.
+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'''.
 For further information on this configuration, see above.
 {{modules}}

← Older revision		Revision as of 11:06, 8 September 2022
Line 72:		Line 72:

	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		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 incorrect '''Vendor Account Number''' value. Ensure that you entered the 2CheckOut correctly in the [[#Adding_the_2CheckOut_Payment_Gateway\|2CheckOut gateway configuration]].
		+
		+	A PE101 error can also be due to an account-level issue that you must resolved 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 [[#Adding_the_2CheckOut_Payment_Gateway\|standard checkout]] can resolve this.

	===Authentication failed===		===Authentication failed===

@@ Line 13: / Line 13: @@
 To set up the 2CheckOut payment gateway in WHMCS:
-# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Payment Gateways'''.
+# Go to the appropriate location for your version of WHMCS:
-# Choose the '''All Payment Gateways''' tab.
+#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations'''.
 # Click '''2CheckOut'''.
 # Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.

@@ Line 24: / Line 24: @@
 # Click the '''Integrations''' tab.
 # Check '''Enable INS''' and '''Enable global URL'''.
-# In the '''Global URL''' field, enter <tt>https://www.yourdomain.com/whmcs/modules/gateways/callback/tco.php</tt>, where <tt>https://www.yourdomain.com/whmcs/</tt> is the URL of your WHMCS installation.
+# 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.
 # Click '''Update'''.
@@ Line 32: / Line 32: @@
 # Navigate to '''Integrations'''.
-# Under '''Redirect URL''' in the '''Approved URL''' field, set the URL to <tt>https://www.yourdomain.com/whmcs/modules/gateways/callback/2checkout.php</tt>, where <tt>https://www.yourdomain.com/whmcs/</tt> is the URL of your WHMCS installation.
+# 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.
 [[File:2checkout_merchantid.png|thumb|2CO Vendor Account Number]]

@@ Line 53: / Line 53: @@
 [[File:2co-api-new.JPG|thumb|2CO API User Setup]]
-If you wish to be able to use the '''inline, recurring billing and automatic refunds functionality''' within WHMCS, then you must setup a 2CheckOut API user and enter the details in these fields.
+To use the inline, recurring billing, and automatic refunds functionality within WHMCS, set up a 2CheckOut API user and enter the details in these fields.
-To setup an API user, you will need to first login to your 2CheckOut account and go to '''Settings > Manage User Access > View Roles > Add Role''' and ensure enable  '''Manage api access''' is ticked. You then need to go to '''Settings > Manage User Access > View Users > Add User''' and create a new user, assigning it to the role just created. Finally, enter the username & password that you just created into the appropriate API username and API password fields inside WHMCS.
+To set up an API user:
 ===Secret Word===
@@ Line 61: / Line 67: @@
 <div class="docs-alert-info">
 <span class="title">Note</span><br />
-The secret word is case-sensitive and should contain letters a-z only.
+The secret word is case-sensitive and should contain the letters a-z only.
 </div>
-For Security, a secret word is set inside your 2CheckOut account, this must be entered into WHMCS for notifications and client redirects to be successful:
+For security, you can set a secret word in your 2CheckOut account. You must enter this into WHMCS for notifications and client redirects.
-* In your 2Checkout Account Navigate to "''Integrations''"
-* Copy the INS Secret Word displayed or generate a new one
+To do this:
-* Paste the INS Secret Word into the ''Secret Word'' field of the 2CheckOut configuration within the WHMCS administration.
 ===Recurring Billing===
-This option allows you to choose the options your clients have to pay when viewing an invoice, or going through the checkout process.
-A recurring payment with 2CheckOut is automatically sent when due without the need for the client to login and pay again. No card details are saved in WHMCS when using 2CheckOut.
+This option allows you to choose your clients' payment options when viewing an invoice or going through the checkout process.
-====Offer Recurring & One Time Payments====
-Allow the choice to your clients by providing both Recurring and One Time Billing options.
+WHMCS can change recurring payments with 2CheckOut without the need for the client to log in and pay again. No card details are saved in WHMCS when using 2CheckOut.
 ====Offer Recurring Only====
 Only provide a recurring button to your clients. The button will only appear when there is a recurring item on the invoice, and when the invoice is not overdue.
 ====Offer One Time Only====
-Only provide the option for One Time payments to your clients. No automatic recurring payments will be received.
 ===Skip 2CO Fraud Check===
-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.
+Check this to 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 chargebacks.
 ===Convert To For Processing===
-For example, if your 2Checkout account is held in ''USD'', then the "Convert To For Processing" setting must also be set to ''USD''. If this is not set properly, your payments may fail.
+This option will only appear in a multi-currency installation. If you use the '''Standard Checkout''' option, you '''must''' set this to the value of the currency your 2Checkout account.
 ==Error Messages==
@@ Line 95: / Line 114: @@
 ===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 '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
+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'''.
-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.
+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">
@@ Line 105: / Line 124: @@
 ===MD5 Hash Failure===
-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.
+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.
-To resolve, update the Secret Word value in WHMCS to match the value in your 2Checkout account
+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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. For further information on this configuration [[#API_Username.2FPassword|see above]].
+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 (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
 {{modules}}