Vtex Installation Guide

Our VTEX integration is designed to connect your shop to the ClearSale analysis center.

We will guide you through the simple steps to integrate ClearSale into your VTEX store.

Before you install ClearSale, please make sure that you have your ClearSale credentials nearby.

If you need any help installing ClearSale, please contact us at integration@clear.sale

First Step - Set up ClearSale Global AntiFraud 

1. Log into your VTEX Admin.

2. Click Payments > Settings.

3. Under Gateway Affiliations, click the green “+” sign.

4. In the AntiFraud section, select ClearSaleGlobal.

5. Fill in the following fields with the information sent to you by the ClearSale integration team.

• Application key and Application token: Provided by ClearSale
• Enable Risk Pre-Analysis. (**Currently only available for Mexico**).
  Yes/No
  If your ClearSale agreement includes risk pre-analysis, leave enabled.
  Leaving it enabled without previous alignment might compromise the integration.

6. When you are finished filling out the details above, click Save.

**Note**
To enable ClearSale’s live production environment, click the Live/in production toggle button.

Second Step - Creating a tag

Creating a tag in Google Tag Manager allows for ClearSale to capture the Device Fingerprint - a crucial piece of data used in analyzing transactions.

1. Access your account in Google Tag Manager.
2. Click on Tag and then on New.
3. Choose the product Personalized HTML Tag.
4. Enter the following script, substituting ‘your_clientid’ with the identifier sent to you by ClearSale (between single quotes):
   

   <script>
       var deviceFingerprintIdCSV4 = 10000000 + Math.floor(Math.random() * 99999999);
       (function (a, b, c, d, e, f, g) {
       a['CsdpObject'] = e; a[e] = a[e] || function () {
       (a[e].q = a[e].q || []).push(arguments)
       }, a[e].l = 1 * new Date(); f = b.createElement(c),
       g = b.getElementsByTagName(c)[0]; f.async = 1; f.src = d; g.parentNode.insertBefore(f, g)
       })(window, document, 'script', '//device.clearsale.com.br/p/fp.js', 'csdp');
       csdp('app', 'your_clientid');
       csdp('sessionid', deviceFingerprintIdCSV4);
       window.vtex.deviceFingerprint = deviceFingerprintIdCSV4;
     </script>

5. Check the option Support for document.write.
6. In Trigger In, select the option More and click on New.
7. Allocate a name to this trigger and choose the event type Personalized Event.
8. In Trigger In, define the name of the event as payment.
9. Save the trigger.
10. Click on the Create Tag button, enter a name for this tag and save.
11. In the top right corner, click on Publish.

Third Step - Specify Payment Condition

ClearSale will only analyze orders associated with the payment conditions you’ve specified. To do so, follow these steps:

1. Access the VTEX Admin.
2. Access the Payments module.
3. Click Settings.
4. Under Payment terms, click on the desired condition, or follow the Set up a payment condition tutorial to create a new condition.
5. Make sure that the payment condition is Enabled.
6. After selecting or creating a new condition, enable the Use AntiFraud option.
7. Select the ClearSale Global option.
8. Click Save.

With these settings in place, ClearSale Global will be ready for use in your store.

**Note**
If you are not using the VTEX available payment methods and would like to send a different one in the custom field, please let us know at integration@clear.sale

Questions?

Customer Service – For questions related to order analysis and requests.

customer.service@clear.sale

Technical Support – For general technical inquiries regarding the extension / functions.

support@clear.sale

Integration Support – For questions related to the initial setup and use of the extension.

integration@clear.sale