1. Locate your plugin in the following list:
   
   • Drupal
   • Magento
   • OpenCart
   • OsCommerce
   • PrestaShop
   • VirtueMart 
   • WHMCS
   • WooCommerce
   • ZenCart
2. Download the latest 2Checkout payment module from GitHub by clicking on the Code button and then on Download ZIP.

3. Follow the installation instructions listed in the README section of GitHub or in the README file downloaded from the ZIP folder.

4. After following the installation instructions from GitHub, make sure you have switched your IPN endpoint to SHA. If you have any issues making the switch, follow the instructions for adding the SHA256/3 hash and deselecting the MD5 hash to your webhook URLs.

1. Log in to your 2Checkout account.
2. Navigate to Dashboard > Integrations > Webhooks and API.
   
3. Click on the INS Settings/IPN Settings/LCN Settings tab.
   Depending on your needs, there are several options for making the switch, as shown below. 

Add a new URL with SHA2/3 hash Recommended

Keep both the SHA2/SHA3 and MD5 hash

Replace the MD5 hash with SHA2/SHA3 

This approach is best if you are using a sandbox environment, or you can afford some service interruption. This is because we will no longer send MD5 hash to this IPN endpoint, and you will need to adapt your integration to support the SHA2/SHA3 algorithm. Check this link for more details.

Troubleshooting

Even after upgrading your INS/IPN/LCN webhooks from MD5 to the SHA2/SHA3 algorithm, you can make sure your daily operations are not impacted, by following these steps:

• Log into your 2Checkout account.

• Navigate to Dashboard > Reports center > API & Webhooks.

  

• Select Webhooks as Event source, IPN (Instant Payment Notification), LNC (License Change Notification), or  INS (Instant Notification Service) as Webhooks and Fail as Status. You can also filter your search by INS/IPN/LCN Order reference. Press on Search.

  

  

• The failed INS(s)/IPN(s)/LCN(s) will be displayed. Select the Action icon to see more information.

  

  

• The retry mechanism is only for the failed INS/IPN/LCN. You can see which one failed via the report and request/response details of each webhook.

  

  

• Additionally, on the order level, you can click on Resend IPN and on the subscription level, you can click on Resend LCN feature in debug mode, to be able to see how your setup behaves:

Resend INS

• Select the failed webhook and click on Resend. 

  

• Click on Proceed for the INS webhook to be resent.

Resend IPN

• Click on the order number, from the Order reference list.
  
• Select Resend notification(s).
  
• Mark the Debug IPN? checkbox and click on Re-send.
  
• On the debugger you can see why the IPN failed and what hash signature was used.
  

• Resend LCN

  • Click on the license number, from the License reference list.
    
  • Select Resend notification(s).
    
  • Mark the Debug LCN? checkbox and click on Re-send.
    
  • On the debugger you can see why the LCN failed and what hash signature was used.
    

For API authentication and instructions on how to generate the hash code check the API Authentication documentation.

In order to generate a Convert Plus trial link, it’s mandatory to have the following parameters in the buy link URL.

Mandatory parameters for all type of buy links (trials included)

• Merchant ID (merchant=ID)
• Template (tpl=default)
• Catalogue Product ID (prod=ID)

Mandatory parameters for the trials flow

• Signature: for building a Trial buy link it is required to generate a signature - ConvertPlus Buy-Link Signature for Catalog Products
• Price (define trial price for the corresponding currency - 0 for free trial, higher than 0 for paid trial); example: tprices=USD%3A10%2CEUR%3A0
• Period (define period – not less than 7 days); example: tperiod=7
• Currency (define currency); example: currency=USD
• Quantity (define quantity – 1 is the only value supported); example: qty=1

How your URL should look like:

https://store.checkout.com/checkout/buy?merchant=merchant&tpl=default&p…¤cy=USD&tprices=USD%3A10%2CEUR%3A0&tperiod=7&signature=e9xe3a3cf015a3ff4ad687b02ba55207de20abb1d24194dcfc53a140d882fc4b

For more details on parameters setup, check ConvertPlus URL parameters.

Limitations:

• the trial period/price applies to a single product
• the trial period can be a minimum of 7 days
• 2Checkout uses the custom prices and ignores the per-product pricing configuration
• supported payment methods: credit and debit cards, PayPal, and Direct Debit
• 2Checkout automatically converts the trial to a paid subscription when the trial interval expires by charging shoppers based on the payment-on-file information. Customers can opt-out at any time using their myAccount

Overview 

The cumulative promotion option enables you to offer the shopper the opportunity to apply two different discounts on the same product. This means that shoppers can add a discount coupon to their checkout carts while still benefiting from the time-limited promotion that you offer. 

Benefits 

• Expand your customer base  
• Increase recurring revenue 
• Enhance and consolidate customer loyalty and satisfaction. 

Availability 

The feature is only available on demand. If you are interested in using this feature, please contact our sales representatives or 2checkout support. 

A cumulative promotion can be applied on top of the following types of promotions: 

• Regular promotions 
• Special price promotions 
• Cross-sell promotions 
• Upsell promotions 

Limitations 

The feature can be applied to all promotions with the following limitations: 

• You cannot apply more than two promotions per product. 
• When the cumulate promotions feature is enabled, the order promotion feature is then automatically set as unavailable. 
• This feature cannot be applied to automatic renewals. The feature can only be applied to new acquisition orders and manual renewals. 
• The shopper cannot apply two cumulative promotions for the same product. You can only apply one standard (non-cumulative) and one cumulative promotion per product. 
• It only applies to eCommerce orders. 
• This does not apply to Convert Plus carts.

Use Cases 

Use Case 1: Gift coupons from affiliates 

1. You sell your product and services through your online platform 
2. You offer discount coupons to affiliate partners. 
3. You set a separate auto-applied promotion for the same product of 10%. 
4. The shopper has a promotion coupon from one of the affiliates.  
5. If the cumulative price promotion feature is activated, the promotion coupon discount will be added on top of the auto-applied 10% promotion. 

Use Case 2: Time-Limited Offers 

1. You provide a 20% discount for the Black Friday weekend on a series of products. 
2. The shopper has a 10% discount voucher they received compensation for a past purchase exceeding 100 EUR. 
3. The cumulative price promotion feature enables the shopper to receive the Black Friday purchase discount as well as the 10% voucher. 
4. The shopper gets a 30% discount on their purchase. 

Add a cumulative promotion

To add a cumulative promotion follow the steps below:

1. Log in to your Merchant Control Panel account.
2. Go to Marketing tools -> Promotions -> Regular promotions. 
3. Click Add regular promotion. 
4. Give a suggestive title and description to your promotion. Shoppers can see the promotion title during purchase. 
5. Make sure that you select to apply the promotion to eCommerce orders. 
6. Select when you want the promotion to run. You can limit promotions to a specific time interval or let them run indefinitely. To start a promotion as soon as you mark it Active, leave the start date empty. If you don't set the end date, the promotion will stop when the maximum number of orders has been reached or will continue to run if the maximum number of orders is unlimited. 
7. Select if you want to apply the Cumulative promotion option or not by clicking on Yes or No.
8. If the promotion is cumulative, you need to select the tax category for the discounted product as well, by selecting an option from the Product tax category drop-down list.
9. Choose the coupon/voucher type: 
   
   • Single - one voucher to impact multiple orders; 
   • Multiple - individual and unique, per-order vouchers. 
10. Select the discount type: 
    
    • Percentage 
    • Fixed 
11. Choose whether or not to apply discounts automatically. Only available for single coupons. This option applies discounts to all selected products in all orders, without allowing shoppers to enter the coupon manually. 
12. Choose whether or not to publish the promotion to the 2Checkout Affiliate Network. 
13. Activate the promotion. 
14. Select the products to be included in the promotion. 
15. Click Save. 
16. You can see your cumulative price promotions displayed on the Regular Promotions page, with the Promotion type set to Cumulative.

How it works 

After the cumulative price promotion is created, it is applied to the shopping cart in the following way: 

1. At any given moment, there can be a maximum of 2 promotions applied for a product: 1 cumulative and 1 non-cumulative. 
2. The cumulative price promotion is always applied last to the purchase. 
3. A promo can replace another promo only if it's the same type (cumulative or non-cumulative. For example, a shopper has two discounts applied to a product and wants to add a third coupon code. If that third coupon code is a cumulative promotion, then it will replace the cumulative coupon previously added to the cart. If that third coupon code is a non-cumulative promotion, then it will replace the non-cumulative coupon previously added to the cart. 
4. If the discount is higher than the value of the order, limit the order value to 0. In other words, any discounts that give a negative price order value should be set to 0. 
5. The nominal value of the cumulative promotion also appears on the invoice sent to the shopper, as a separate entry in the product list.

Overview 

The best price promotion feature enables you to offer the shopper the opportunity to get the best discount out of the available options. The feature calculates which is the most advantageous promotion out of two different promotions, when the shopper attempts to introduce a coupon to the cart. After the calculation, the feature will apply the best coupon out of the two. 

Benefits 

• Expand your customer base  
• Increase recurring revenue 
• Enhance and consolidate customer loyalty and satisfaction
• Reduce cart abandonment  

Availability 

The feature is only available on demand. If you are interested in using this feature, please contact our sales representatives or 2checkout support. 

The feature can be applied to the following types of promotions: 

• Regular promotions 
• Multi-product promotions 
• Special price promotions 
• Cross-sell promotions 
• Upsell promotions 

Limitations 

The feature can be applied to all promotion types with the exception of order promotions. 

Use Case 

1. You sell your product and services through your online platform.
2. You offer discount coupons to affiliate partners. 
3. You set a separate auto-applied promotion for the same product of 10 per cent. 
4. The shopper has a promotion coupon from one of the affiliates of 15 per cent.  
5. If the best price promotion feature is activated, the affiliate coupon will be applied instead of the auto applied one as it offers a greater discount. 

How it works 

After the best price promotion is activated by the Verifone Administrator, the feature is applied automatically for every shopper transaction.  

1. When the shopper applies a discount coupon to the order and an auto-applied promotion is already running, the best price promotion feature will ensure that the promotion with the best discount will be applied only. 
2. When the shopper applies two vouchers one after the other for the same order, only the one with the best discount will be applied. 
3. If the latest coupon applied results in a lower discount than the previous one, you will be alerted by the following error message: The previous discount is offering you a better deal. You can only change it with a more advantageous coupon. 

Overview 

The feature facilitates your customer to experience faster and easier updates to your products. Renewal with a new product version enables your customer to automatically get an updated version of your product during the subscription renewal process. The feature also enables you to choose which version the shopper updates to, whether it is the latest version or another version which predates the latest one. 

Benefits 

• Enabling easier updates for your customers 
• Enhancing their user experience and assuring customer satisfaction 

Availability 

The feature is available to all merchants using subscription services. 

Limitations 

The feature can be applied to all subscriptions with the limitation that the intermediary upgrade option is only available upon request. 

Use Cases 

Use Case 1: Renewal with the Latest Product Version 

1. You have an online shop selling digital products, amongst these being anti-virus software that is being updated yearly. 
2. A customer has the 2022 version of the product.  
3. Upon renewal, the new product on the subscription will be the 2023 version of the product, without any additional actions for the shopper. 

Use Case 2: Multi-Step Renewal with an Intermediary Product Version for better customer retention 

1. You have an online shop selling your products. 
2. You want to offer differentiated product packaging for renewing customers, depending on the current version of their subscription plan. For the customer that initially subscribed to the standard version of your product, you can reward them by automatically updating their plan to a product with more features when they renew the first time.  
3. For the same customers, the next time they renew you can reward them by automatically updating their product and their subscription plan with even more features and benefits.  

Use Case 3: Silent upgrade & intermediary silent upgrade in Channel Manager

Channel Manager now supports renewal with a different product version and allows merchants to deprecate old products and transition partners to new versions. If the targeted product at renewal is not in the partner's price list, the subscription should renew with the same product.

The intermediary silent upgrade enables merchants to offer partners different renewal prices depending on the number of renewals. For example, if a merchant sells product A with a 10% new acquisition discount to their partner, after one year, the partner gets a 15% renewal discount; if the partner renews a second time, the renewal discount is 25%.

The silent upgrade can be leveraged by any merchant using Reseller management.

Renewal with a new product version 

To apply a renewal with a new product version, you must follow the following steps: 

1. Navigate to Products, under Setup, and run a search to identify the upgraded product. Click to edit it, and then select the Upgrade tab. 
2. Choose the upgradable products from the list in the Edit your upgrade options area. Multiple selections are possible when holding down the CTRL key. 
3. In the Renewal with a new product version section, you can select the following options: 

• This is an intermediary version before upgrading to the final product version if you want to make an intermediary update to a closer version before updating to the latest version 
• 2Checkout Monthly Subscription is a newer version of other products if you want to update the customers to the latest version 

How it works 

After the renewal with a new product version is activated, it is applied in the following way at renewal time: 

1. For the intermediary upgrade mode, it will first upgrade from the deprecated version to the next product version in the upgrade schema. At the next renewal, the subscription will be upgraded to the newer/last product version. This is illustrated in the diagram below.
2. If the intermediary upgrade is not activated, then the deprecated version will be directly updated to the latest version of the product. This is illustrated in the diagram below.

Overview

The newly developed “alloy.js” library from Adobe is a JavaScript library that helps merchants measure how users interact with their website.

The new approach of the current “alloy.js” is that it improves:

• Page performance by loading a smaller tracking library.
• Use the same visitor identifier across different solutions from Adobe platform.
• On client-side data, it minimizes the transmissions from website to Adobe platform.

Implementing Adobe Analytics using the Adobe Experience Platform Web SDK (alloy.js) probably will charge fees, so be in touch with your Adobe provider. For more information on the Adobe Experience Platform Web SDK and how to install it, click here.

Setting the Adobe Analytics configuration

To implement Adobe Analytics on your website, follow these steps: 

1. Log into your 2Checkout (now Verifone) Merchant Control Panel and navigate to Setup.
2. Select Ordering Options.
3. Click on the Analytics tab.
4. Click on the Convert Plus & Inline Checkout button.
5. In the Adobe Analytics panel click on Setup.
   
   
6. Fill in the two fields. The information can be extracted from the datastream creation in the Adobe platform.
   
   
   
   The Adobe Analytics Edge Configuration ID and Experience Cloud Organization ID can be found in Adobe Experience Platform.
   • The Edge Configuration ID means Datastream ID and represents the ID of the configuration that is set on the datastream created for transferring data to the Adobe Analytics module.
   • The Organization ID means the ID that Adobe is creating for a user and helps the Adobe Platform to recognize the user between the changes from different module/applications.

   

7. Click on the Inactive button to activate the configuration credentials for Adobe Analytics.
   
   

Setting the Adobe Experience Platform for using Adobe Analytics

To implement a report in Adobe Analytics from the data sent in the shopping cart, first you need to create a datastream and a schema to set the logic data into the datastream.

1. Go to Adobe Experience Platform and click on the Schemas option from the left side panel. Then, click on the Create schema button. This schema should use the XDM Adobe pre-build schemas in order for the data to be recognized in the Adobe Analytics report.
   
   The XDM ExperienceEvent is used as the primary selection for the Adobe pre-build class because this is the way that Adobe Analytics service can recognize the schema in the datastream.
   
   
2. In the new schema, go to Scheme properties and enter the Display name and Description. In the left-side panel, go to the Fields group and click on Add; this will open the pre-built schema for Adobe Analytics to be selected.
   
      This step is very important as here we get the data that will be mapped in the datastream with the data sent from the shopping cart.

   

3. After saving the schema, go back to the Datastreams section, and create a New Datastream, selecting the already created schema from the Event schema drop-down option.
   
   

The steps on how to map the data will be treated in the section Mapping the data to Adobe Analytic context.

All of these 3 steps can be reproduced in the Adobe Experience Platform Data Collection module from the same Adobe Experience Cloud environment.

Mapping the data to Adobe Analytics context

For mapping the correct data into Adobe Analytics module, the 2Checkout comes with the schema that is sent from the shopping cart. For mapping the data, you need to know two aspects, one of the data that is sent from 2Checkout, and secondly, the data recognized (or created as new evar/events) in the Adobe Experience Platform.

Data sent from 2Checkout

A general overview of this data is presented in the code snippet below:

{
  "event": "checkout",
  "ecommerce": {
    "currencyCode": "string required",
    "sessionId": "string required",
    "checkout": {
      "actionField": {"<< ActionField object >>"},
      "products": ["<< List of product object >>"]
    },
    "purchase": {
      "actionField": {"<< ActionField object >>"}
    },
    "products": ["<< List of product object >>"],
    "add": {
      "products": ["<< List of product object >>"]
    },
    "remove": {
      "products": ["<< List of product object >>"]
    },
    "impressions": ["<< List of impression object >>"]
  },
  "PAGE_NAME": "string => string",
  "VENDOR_CODE": "string => string",
  "ONESTEPCART": "true => bool",
  "SHORT_FORM": "true => bool",
  "PURCHASE_COMPLETE": "bool",
  "TEST_ORDER": "bool => bool",
  "PRODUCT_SOURCE": "string",
  "CART_LOCK": "bool => bool",
  "DISCOUNT_COUPON_STATUS": "string",
  "AUTO_RENEWAL": "string => string",
  "PURCHASE_TYPE": "string => string",
  "LANGUAGE": "string => string",
  "BILLING_COUNTRY": "string",
  "VISITOR_COUNTRY": "string",
  "BILLING_CURRENCY": "string",
  "COMPANY_NAME": "string",
  "ORDER_EXT_REF": "string",
  "CUSTOMER_EXT_REF": "string",
  "TEMPLATE_LAST_MODIFIED_DATE": "string",
  "TEMPLATE_CREATION_DATE": "string",
  "PAGE_STYLE_NAME": "string",
  "ADDITIONAL_HIDDEN_FIELDS": "array",
  "SELLER_TYPE": "string",
  "PAYMENT_METHOD": "string",
  "PAYMENT_METHOD_TYPE": "string",
  "QUANTITY_CHANGED": "string",
  "CART_STEP": "string",
  "ADDITIONAL_FIELDS_COUNT": "number",
  "SOURCE": "string",
  "PURCHASE_FLOW": "string",
  "CREDIT_CARD_INSTALLMENTS": "string",
  "LEAD_MANAGEMENT": "string",
  "PAYMENT_CATEGORY": "string",
  "time": "number"
}

In the next tables, each event is described in detail:

Data needed from Adobe Experience Platform

Go back to the new created datastream from Adobe Platfom, and click on the Edit Mapping section.

Here is an example of a partial mapped scheme:

How to create Events and Variables in the Adobe Analytics application

1. Log into Adobe Analytics.
2. Go to Admin > Report Suites.
   
   
3. Click on the Report suites for which you want to build variables or events.
   
   

Example on how to build a custom event in Adobe Analytics:

• Click on Edit Settings > Conversion > Success Events to build custom events.
  
  
• Click on Add New and then define the new event, for example event10: write a name for the event (ex: “Product Discount Value”).
• Under the Type column, select Currency if a monetary value is sent under this event, as in the example below. The other fields should be left as preselected by Adobe in this example.
  
  
• Click the Save button at the bottom of the page.
  
  
• After the event was created, it will appear in Adobe Analytics Workspaces, if you search for “event10” in the left-side panel.
  
  

Example on how to build a custom variable in Adobe Analytics

A. Session level variable – example evar8 Order ID (order ID/ purchase ID is not captured automatically by Adobe; if we want to capture this value, then it needs to be captured under a custom evar)

• Click on Edit Settings > Conversion > Conversion Variables to build custom variables.
  
  
• Click on Add New and define the new variable, for example evar8, add as name Order ID. Select Linear as allocation for order ID.
  
  
• Click Save at the bottom of the page.
• After the evar was created, it will appear in Adobe Analytics Workspaces, if you search for evar8 in the left-side panel.
  
  

B. Merchandising variable (this is a product level variable) – example evar26 Product Discount Coupon Value

• Click Add New and define the new variable with Product Name “Product Discount Coupon Value”
• Click Enable merchandising (this is only applicable for merchandising evars – evars that send information specific for certain products, e.g., certain products in an order can have different coupon discounts).
• For Merchandising click Product Syntax from the drop-down list and Allocation Most Recent (Last).
  
  
• Click Save at the bottom of the page.
• After the evar was created, it will appear in Adobe Analytics Workspaces, if you search for evar26 in the left-side panel.
  
  

Overview

We will stop supporting the MD5 algorithm in our platform and impacted merchants will have to switch to SHA. The decommissioning will be carried out in two stages, having the deadline for the first phase on 15th of August, 2024 and the deadline for the second phase on 30th of June, 2025.

Availability

Areas in which MD5 will no longer be available are the following:

Phase One (deadline: 15th of August, 2024)

• API
• Webhooks (IPN and LCN)
• Shopping cart integrations
• Electronic delivery
• Buy links generated using MD5 hash

Phase Two (deadline: 30th of June, 2025)

• Finish page (BACK_REF parameter)
• Instant Notification Service (INS)
• Instant Refund Notification (IRN)
• Instant Delivery Notification (IDN)
• Instant Order Search Export (ISE)

Benefits

• Keeping up to date with technical security advancements.
• Increasing the security for authentication and removing potential security breaches.
• Secure and robust while being compatible with the existing algorithms in terms of the number of bits and representation size​