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.
Log in to your 2Checkout account.
Navigate to Dashboard > Integrations > Webhooks and API.
Click the INS Settings / IPN Settings / LCN Settings tab based on the webhook type you are updating. Depending on your needs, there are several options for making the switch.
Click on Add endpoint.
Add the new INS name and URL, select the hashing algorithm, then click Save endpoint.
After setting up the URL for the new endpoint, navigate to the trigger list associated with the endpoint and click Edit.
On the next page, scroll to the Parameters section, deselect the md5_hash parameter, select the hash parameter, and click Save trigger.
The new INS endpoint and its hashing algorithm will appear in the URL list. When ready, remove the old endpoint with MD5 and use only the SHA endpoint.
Optionally, for enhanced security, you can validate the hash received in INS. See: https://verifone.cloud/docs/2checkout/API-Integration/Webhooks/Instant-Notification-Service-%2528INS%2529/INS-read-receipt-response
Click Add IPN URL.
Add the IPN URL and select the hash algorithm.
The new IPN URL and its hashing algorithm will appear in the URL list. When ready, remove the old endpoint with MD5 and use only the SHA endpoint.
This option is suitable for merchants already using the LCN in production and processing orders through the platform.
Click Add LCN URL.
Add the LCN URL and select the hash algorithm.
The new LCN URL and its hashing algorithm will appear in the URL list. When ready, remove the old endpoint with MD5 and use only the SHA endpoint.
You will receive notifications with multiple hash parameters. Adjust your integration to correctly process the extra hash parameter and respond with the new algorithm. See this article for IPN code samples.
Click Edit for the existing URL corresponding to your default IPN listener.
Select the additional hash algorithm and click Save.
The changes will be shown in the URL list.
After you successfully validate notifications using SHA2/SHA3, remove the MD5 hash from your endpoint.
This approach may be suitable for merchants using LCNs, allowing a smooth transition: both hashes will be sent in LCN until August 15th, 2024.
Prerequisite: Adjust your integration to process multiple hash parameters. See LCN code samples: https://verifone.cloud/docs/2checkout/API-Integration/Webhooks/08License_Change_Notification_%2528LCN%2529/LCN-code-sample
Click Edit for the URL corresponding to your default LCN listener.
Select the additional hash algorithm and click Save.
The changes will be shown in the URL list.
After you successfully validate notifications using SHA2/SHA3, remove the MD5 hash from your endpoint.
This approach is best if you are using a sandbox environment or can accept service interruption because MD5 will no longer be sent to the endpoint until you update your integration to support SHA2/SHA3. Check this link for more details.
INS switch to SHA2/3: https://verifone.cloud/docs/2checkout/API-Integration/01Start-using-the-2Checkout-API/2Checkout-API-general-information/Migration_guide_SHA2_SHA3/Webhooks_upgrade_to_the_SHA_algorithm#-tab-0-name
IPN switch to SHA2/3: https://verifone.cloud/docs/2checkout/API-Integration/01Start-using-the-2Checkout-API/2Checkout-API-general-information/Migration_guide_SHA2_SHA3/Webhooks_upgrade_to_the_SHA_algorithm#-tab-1-name
LCN switch to SHA2/3: https://verifone.cloud/docs/2checkout/API-Integration/01Start-using-the-2Checkout-API/2Checkout-API-general-information/Migration_guide_SHA2_SHA3/Webhooks_upgrade_to_the_SHA_algorithm#-tab-2-name
Click Edit for the existing endpoint corresponding to your default INS listener.
Selecting any of the SHA algorithms will automatically deselect MD5. Click Save endpoint.
The changes will be shown in the endpoint list.
After setting up the URL, navigate to the trigger list, click Edit for the trigger, deselect md5_hash, select the hash parameter, and click Save trigger.
Optionally, validate the hash received in INS (link placeholder in original).
Click Edit for the existing URL corresponding to your default IPN listener.
Select the SHA algorithm and deselect MD5. Click Save.
The changes will be shown in the URL list.
Click Edit for the existing URL corresponding to your default LCN listener.
Select the SHA algorithm and deselect MD5. Click Save.
The changes will be shown in the URL list.
Even after upgrading your INS/IPN/LCN webhooks from MD5 to SHA2/SHA3, verify operations using the reports and retry features.
Log in to your 2Checkout account.
Navigate to Dashboard > Reports center > API & Webhooks.
Select Webhooks as Event source, choose IPN, LCN, or INS as Webhooks, and Fail as Status. Optionally filter by Order/License reference. Press Search.
Failed entries will be listed. Click the Action icon for details.
Related:
Last updated
Was this helpful?
Was this helpful?
