Skip to main content

Electronic delivery of codes upgrade to the SHA algorithm

 

   You only need to follow this procedure if you’re using active lists for your delivery keys. Check this article to learn how to generate the hash algorithm. 
  1. Log into your 2Checkout account.

  2. Navigate to Dashboard > Setup > Fulfillment.

  3. Open an existing dynamic list or add a new code list, selecting the List type Dynamic.

    New code list

  4. Click on Set URL if you’re creating a new list.

    Set URL

  5. If you’re editing an existing dynamic list, click on Change or Debug key generator to modify the hash algorithm.

    change

  6. Select SHA2 or SHA3 as a hashing algorithm.

    Hash algorithm

  7. Select a product and fill in the delivery information form with test data.

    product info

  8. Click on Step 4. Debug >>.

    debug

  9. A successfully green banner is displayed if all is correct. Click on Step 5. Change URL >>.

    change URL

  10. A second confirmation message will be displayed if the change was successfully applied (Successfully saved the key generator URL).

    confirmation message

Buy links upgrade to the SHA algorithm

If you’re using buy links with MD5 hash on your website or in any other part of your flow, you’ll need to re-create the links with SHA2/ SHA3. For more information on how to manually re-create these links check the Buy-link parameters article.

To re-create the “On the fly pricing” buy links with the SHA algorithm, follow the steps below:

  1. Log into your 2Checkout account.

  2. Navigate to Dashboard > Setup > Generate links.

    Generate links screen

  3. Select the purchase flow, the product and click on the On the fly pricing option.

    On the fly pricing option

  4. Select the pricing options and click Generate link. This will generate a link signed with SHA that you can copy and use in your integrations. 

Shopping cart integration upgrade to the SHA algorithm

  SHA3 is already supported for Shopify and Wix and no actions are required.
  1. Locate your plugin in the following list:
  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.

Webhooks upgrade to the SHA algorithm

If you are using  shopping cart integration , make sure to follow the instructions from the  Shopping cart integration upgrade to the SHA algorithm documentation  first.
  1. Log into your 2Checkout account.
  2. Navigate to Dashboard > Integrations > Webhooks and API.
    Webhooks and API screen
  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

  • Click on Add endpoint.

  • Add the new INS name, and URL and select the hashing algorithm. Then click on Save endpoint. 

  • After setting up the URL for the new endpoint, navigate to the trigger list associated with the endpoint and click on Edit to edit the trigger. 

edit trigger

  • On the next page, scroll down to the Parameters section, deselect the md5_hash parameter, select the hash parameter, and click on Save trigger. 

edit parameter

  • The new INS endpoint with its hashing algorithm will be displayed in the URL list. When you’re ready, remove the old endpoint with MD5 and use only the one with the SHA algorithm.  

  • Optionally, for enhanced security of your webhooks, you can validate the hash received in INS. Click here to learn how. 

new endpoint

  • Click on Add IPN URL.

IPN settings

  • Add the IPN URL and select the hash algorithm.
  • The new IPN URL with its hashing algorithm will be displayed in the URL list. When you’re ready, remove the old endpoint with MD5 and use only the one with the SHA algorithm.

IPN settings sha

This option is suitable for merchants already using the LCN in a production environment and processing orders through the platform.

  • Click on Add LCN URL.

LCN settings

  • Add the LCN URL and select the hash algorithm.
  • The new LCN URL with its hashing algorithm will be displayed in the URL list. When you’re ready, remove the old endpoint with MD5 and use only the one with the SHA algorithm.

LCN settings sha

Keep both the SHA2/SHA3 and MD5 hash

   Prerequisite:
This approach means that you will receive an IPN with multiple hash parameters. Therefore, you will first need to adjust your integration to be able to correctly process the extra hash parameter and respond with the new algorithm. Check this article for some IPN code samples.
  • Click on the Edit button to edit an existing URL corresponding to your default IPN listener.
    Edit IPN hash
  • Select the additional hash algorithm. Click on Save.
    IPN save new hash
  • The changes in the hashing algorithm will be displayed in the URL list.
    IPN new hash URL
  • After you successfully manage to validate the notification using the SHA2/SHA3 hash algorithm, remove the MD5 hash from your endpoint.

This approach might be suitable for merchants that have been selling through the platform and have been using LCNs. This will allow a smooth transition from one hashing algorithm to another, as both will be sent in the LCN until August 15th, 2024.

   Prerequisite:
This approach means that you will receive an LCN with multiple hash parameters. Therefore, you will first need to adjust your integration to be able to correctly process the extra hash parameter and respond with the new algorithm. Check this article for some LCN code samples.
  • Click on the Edit button to edit an existing URL corresponding to your default LCN listener.
    LCN edit URL hash
  • Select the additional hash algorithm. Click on Save.
    LCN select URL hash
  • The changes in the hashing algorithm will be displayed in the URL list.
    LCN new URL hash
  • After you successfully manage to validate the notification using the SHA2/SHA3 hash algorithm, remove the MD5 hash from your endpoint.

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.

  • Click on the Edit button to edit an existing endpoint corresponding to your default INS listener. 

edit endpoint

  • Selecting any of the SHA algorithms automatically deselects the MD5 hash. Click on Save endpoint. 

INS settings sha 1

  • The changes in the hashing algorithm will be displayed in the endpoint list. 

new hash

  • After setting up the URL for the new endpoint, navigate to the trigger list associated with the endpoint and click on Edit to edit the trigger. 

edit trigger 1

  • On the next page, scroll down to the Parameters section, deselect the md5_hash parameter, select the hash parameter, and click on Save trigger. 

edit parameter sha

  • Optionally, for enhanced security of your webhooks, you can validate the hash received in INS. Click here to learn how. 
  • Click on the Edit button to edit an existing URL corresponding to your default IPN listener.

IPN settings sha 3

  • Select the additional hash algorithm and deselect the MD5 hash. Click on Save.

  • The changes in the hashing algorithm will be displayed in the URL list.

IPN settings sha 2

  • Click on the Edit button to edit an existing URL corresponding to your default LCN listener.

LCN settings sha 1

  • Select the additional hash algorithm and deselect the MD5 hash. Click on Save.

LCN settings sha 1

  • The changes in the hashing algorithm will be displayed in the URL list.

LCN settings sha 3

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.

    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.

    report settings

    INS troubleshooting 1

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

    Action

    INS troubleshooting 2

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

    info box

    INS troubleshooting 3

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

    resend ins 1

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

resend ins 2

Resend IPN

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

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

ConvertPlus Trials Flow

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

Cumulative promotions 

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: 

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. Cumulative promotion tax category
  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. Activate Cumulative Promotion
   The cumulative promotion checkbox is only available if activated by a Verifone admin. Once created, the cumulative promotion can be added to another regular, special price, cross-sell and upsell promotion.

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.

Cumulative Promotion Invoice

 

 

Best Price Promotions 

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. Error Message

Renewal with a new product version

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 

Options-Upgrade with a New Product 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. Intermediate Option
  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. Latest Version Option

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo