As a Merchant of Record (MoR), 2Checkout is legally responsible for complying with the scheme, acquirer, as well as local/regional consumer protection regulations, when it comes to communication distributed to shoppers through emails triggered by our platform.

Example of a compliant follow-up email:

A. Create a tag for Facebook Pixel Page View Initialization

Create this tag if you don’t already have a Facebook Pixel tag on your website that fires on all pages where you have the Google Tag Manager code.

1. Click to create a new tag.

2. As Tag Type select Custom HTML. In the script below, under '{your-pixel-id-goes-here}' type your Facebook pixel. The script below is the Pixel Base Code and can be found in the Facebook/Meta Pixel documentation.

   <!-- Facebook Pixel Code -->
   <script>
     !function(f,b,e,v,n,t,s)
     {if(f.fbq)return;n=f.fbq=function(){n.callMethod?
     n.callMethod.apply(n,arguments):n.queue.push(arguments)};
     if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0';
     n.queue=[];t=b.createElement(e);t.async=!0;
     t.src=v;s=b.getElementsByTagName(e)[0];
     s.parentNode.insertBefore(t,s)}(window, document,'script',
     'https://connect.facebook.net/en_US/fbevents.js');
     fbq('init', '{your-pixel-id-goes-here}');
     fbq('track', 'PageView');
   </script>

3. As Triggering select All Pages.
   

B. Create a User-defined variable in Google Tag manager called “ecommerce”

1. Click on New, to create a new user-defined-variable.
   
2. As Variable Type, select Data Layer Variable.
3. As Data Layer Variable Name, add ecommerce in the field.
4. As Data Layer Version select Version 2.
   

C. Create a User-defined variable in Google Tag Manager for Facebook called ConvertPlus - FacebookEventsScript

1. Click on New to create a new user-defined-variable.
   
2. As Variable Type select Custom JavaScript.

3. In the Custom JavaScript section paste the below code.

   function(){
     var attr = {};
     attr.currency = "USD";
     attr.content_type = "product";
     var fbContents,fbIds,fbNames,i;
   //function fbData
   var fbData = function() {
   fbContents = [];
       fbIds = [];
       fbNames = [];
       attr.num_items = {{ecommerce}}.items.length;
       for(i=0;i<{{ecommerce}}.items.length;i++){
         fbContents.push({
          'id':{{ecommerce}}.items[i].item_id,
          'name':{{ecommerce}}.items[i].item_name,
          'quantity':{{ecommerce}}.items[i].quantity
         });
        	fbIds.push({{ecommerce}}.items[i].item_id);
         fbNames.push({{ecommerce}}.items[i].item_name);
      	 }
       attr.contents = fbContents;
       attr.content_ids = fbIds;
       attr.content_name = fbNames;
   	};
     if({{Event}} === 'begin_checkout'){         
       attr.value = {{ecommerce}}.actionField.checkout_valueUSD; 
       fbData();   
     }
     if({{Event}} === 'purchase'){
      attr.value = {{ecommerce}}.actionField.valueUSD; 
       fbData();
     }
     return attr;
   }

D. Create a trigger specifically for the purchase event

Create a new trigger which is restricted only to the purchase event and name it Event Ecommerce Purchase Only.

1. As Trigger Type, select Custom Event.
2. As Event name, type purchase.
3. For this trigger to fire on, select All Custom Events.
   

E. Create a tag for the Facebook Pixel for the purchase event

1. Create a new tag named for example Facebook Purchase ConvertPlus.
2. As Tag Type select Custom HTML.

3. In the HTML section, paste the following code:

   <script>
    fbq('track', 'Purchase', {{ConvertPlus - FacebookEventsScript}},{eventID:
   {{ecommerce}}.transaction_id});
   </script>
   

4. For Triggering, select the Trigger for Event Ecommerce Purchase only, the trigger that is only restricted to the purchase event.
   

Optional! – send information with the Facebook Pixel at checkout if needed

Create a trigger specifically for the checkout event

Create a new trigger which is restricted only to the purchase event and name it Event Ecommerce Checkout Only.

1. As Trigger Type, select Custom Event.
2. As Event name, type begin_checkout.
3. For this trigger to fire on, select All Custom Events.
   

Create a tag for the Facebook Pixel for the checkout event

1. Create a new tag named for example Facebook Checkout ConvertPlus.
2. As Tag Type select Custom HTML.

3. In the HTML section, paste the following code:

   <script>
     fbq('track', 'InitiateCheckout', {{ConvertPlus - FacebookEventsScript}});
   </script>
   

4. For Triggering, select the Trigger for Event Ecommerce Checkout only, the trigger that is only restricted to the checkout event.
   

A. Create a tag for Facebook Pixel Page View Initialization

Create this tag if you don’t already have a Facebook Pixel tag on your website that fires on all pages where you have the Google Tag Manager code.

1. Click to create a new tag.

2. As Tag Type select Custom HTML. In the script below, under '{your-pixel-id-goes-here}' type your Facebook pixel ID. The script below is the Pixel Base Code and can be found in the Facebook/Meta Pixel documentation.

   <!-- Facebook Pixel Code --> 
   <script> 
     !function(f,b,e,v,n,t,s) 
     {if(f.fbq)return;n=f.fbq=function(){n.callMethod? 
     n.callMethod.apply(n,arguments):n.queue.push(arguments)}; 
     if(!f._fbq)f._fbq=n;n.push=n;n.loaded=!0;n.version='2.0'; 
     n.queue=[];t=b.createElement(e);t.async=!0; 
     t.src=v;s=b.getElementsByTagName(e)[0]; 
     s.parentNode.insertBefore(t,s)}(window, document,'script', 
     'https://connect.facebook.net/en_US/fbevents.js'); 
     fbq('init', '{your-pixel-id-goes-here}'); 
     fbq('track', 'PageView'); 
   </script> 

3. As Triggering select All Pages.
   

B. Configure dataLayer variables in Google Tag Manager

Configure dataLayer variables in Google Tag Manager to further use them in the Facebook implementation.

2checkout shopping carts contain a dataLayer with eCommerce information on the Google Analytics 4 structure. You can view this by typing dataLayer into the browser console and under gtag4, you can see the eCommerce information on Google Analytics 4 structure both at checkout and at purchase on the order Finish page.

1. Configurate variables in Google Tag Manager
   To capture the eCommerce information from the dataLayer, you will first need to configurate certain data layer variables in Google Tag Manager. You can then use those variables in the script for the Facebook Pixel tracking.
   1. Create a variable called gtag4.event in Google Tag Manager
      Click to create a new User-Defined Variable in Google Tag Manager. Name you variable “gtag4.event” to keep track of it easier.
      
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.event.
      Under Data Layer Version select Version 2.
      
   2. Create a variable called gtag4.currency in Google Tag Manager
      Click to create a new User-Defined Variable in Google Tag Manager. Name your variable “gtag4.currency” to keep track of it easier.
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.currency.
      Under Data Layer Version select Version 2.
      
   3. Create a variable called gtag4.items in Google Tag Manager
      Click to create a new User-Defined Variable in Google Tag Manager. Name your variable “gtag4.items” to keep track of it easier.
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.items.
      Under Data Layer Version select Version 2.
      
   4. Create a variable called gtag4.tax in Google Tag Manager
      Click to create a new User-Defined Variable in Google Tag Manager. Name your variable “gtag4.tax” to keep track of it easier.
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.tax.
      Under Data Layer Version select Version 2.
      
   5. Create a variable called gtag4.transaction_id in Google Tag Manager
      Click to create a new User-Defined Variable in Google Tag Manager. Name your variable “gtag4.transaction_id” to keep track of it easier.
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.transaction_id.
      Under Data Layer Version select Version 2.
      
   6. Create a variable called gtag4.value in Google Tag Manager to capture the total value of the order, including tax
      Click to create a new User-Defined Variable in Google Tag Manager. Name your variable “gtag4.value” to keep track of it easier.
      As Variable Type select Data Layer Variable from the options provided by Google.
      Under Data Layer Variable Name type gtag4.value.
      Under Data Layer Version select Version 2.
      

C. Create a User-defined variable in Google Tag Manager for Facebook called FacebookEventsScript

1. Click on New to create a new user-defined-variable.
   
2. As Variable Type select Custom JavaScript.

3. In the Custom JavaScript section paste the below code. This code will capture product, transaction id and transaction value data, using the dataLayer variables previously created.

   function(){
     var attr = {};
     attr.currency = {{gtag4.currency}};
     attr.content_type = "product";
     var fbContents = [];
     var fbIds = [];
     var fbNames = [];
   //function fbData
   var fbData = function() {
       attr.num_items = {{gtag4.items}}.length;
       for(var i=0;i<{{gtag4.items}}.length;i++){
         fbContents.push({
          'id':{{gtag4.items}}[i].item_id,
          'name':{{gtag4.items}}[i].item_name,
          'quantity':{{gtag4.items}}[i].quantity
         });
        	fbIds.push({{gtag4.items}}[i].item_id);
         fbNames.push({{gtag4.items}}[i].item_name);
      	 }
       attr.contents = fbContents;
       attr.content_ids = fbIds;
       attr.content_name = fbNames;
   	};
   if ({{gtag4.event}} === 'begin_checkout' && window.omniture_vars && window.omniture_vars.CART_PRODUCTS){
   	var checkoutValue=0;
   	var checkoutCartProducts = omniture_vars.CART_PRODUCTS;
   	for (var i=0; i<checkoutCartProducts.length;i++){
   	checkoutValue += Number(checkoutCartProducts[i].ProductTotalPriceWithTaxAndDiscount * checkoutCartProducts[i].ProductQuantity); 
   	}
       checkoutValue = parseFloat(checkoutValue.toFixed(2))
       attr.value=checkoutValue;
   	fbData();
   }
     if({{gtag4.event}} === 'purchase'){
      attr.value = {{gtag4.value}}; 
       fbData();
     }
     return attr;
   }

D. Create a trigger specifically for the purchase event

Create a new trigger which is restricted only to the purchase event and name it Purchase Event Only.

1. As Trigger Type, select Custom Event.
2. As Event name, type 2checkout event.
3. For this trigger fires on, select Some Custom Events.
4. Add the condition that variable gtag4.event equals purchase.
   

E. Create a tag for the Facebook Pixel for the purchase event

1. Create a new tag, named, for example Facebook Purchase.
2. As Tag Type select Custom HTML.

3. In the HTML section, paste the following code (this code will send product, transaction id and transaction value data to Meta when a purchase takes place).

   <script>
     fbq('track', 'Purchase', {{FacebookEventsScript}}, {eventID: {{gtag4.transaction_id}}});
   </script>

4. For Triggering, select the Trigger for Event Ecommerce Purchase only, the trigger that is only restricted to the purchase event.
   

Optional! – send information with the Facebook Pixel at checkout if needed

Create a trigger specifically for the checkout event

Create a new trigger which is restricted only to the checkout event and name it Checkout Event Only.

1. As Trigger Type, select Custom Event.
2. As Event name, type 2checkout event.
3. For this trigger to fire on, select Some Custom Events.
4. Add the condition that variable gtag4.event equals checkout.
   

Create a tag for the Facebook Pixel for the checkout event

1. Create a new tag, named, for example Facebook Checkout.
2. As Tag Type select Custom HTML.

3. In the HTML section, paste the following code:

   <script>
     fbq('track', 'InitiateCheckout', {{FacebookEventsScript}});
   </script>
   

4. For Triggering, select the Trigger for Event Ecommerce Checkout only, the trigger that is only restricted to the checkout event.
   

Overview

Instant Tax Rate Export allows you to extract the tax rate information for your products as a JSON. The resulting file will contain the tax rates for each country & state (where applicable) for the product tax category provided, including zip codes* if requested (where applicable).

Availability

ITE is available to all 2Checkout accounts.

Rate limit: this service is rate limited and can only be accessed by an account 20 times each day. Tax Rates exported at the beginning of the day should be stored by you for the rest of the day, do not call this service for each customer.

Method and URL

POST: https://secure.2checkout.com/action/taxes.php

Request parameters

2Checkout captures the parameters you send and exports the data to the client.

Requirements

HASH validation

• To validate the SHA2/SHA3 hash signature, you're required to include all mandatory parameters. 2Checkout throws an error if one of these parameters is missing.
• Use UTC for the time zone of REQ_DATE. The difference between the value of REQ_DATE and the moment when you send the request to 2Checkout must be smaller than 5 minutes, or 2Checkout will respond with the 'Request expired' error message.

Authentication

Authenticate requests using:

• HASH. This ia a SHA2/SHA3 Hash-based message authentication code (HMAC) that you create using your account's secret key and the parameters marked as mandatory for HASH validation. To build the source string, prepend each value with its own length in bytes. Use 0 for null or empty values without prepending their length. However, when the value is 0 (zero), you do need to prepend its length (1). Note that for UTF-8 characters the length in bytes can be longer that the string length.
• REQ_DATE. Use UTC time zone.

Optional: The authentication can be restricted by IP or range of IPs from firewall (Accounts settings > User access > Firewall) for the special service user. If the IP from where you make the request is not configured in 2Checkout, the authentication fails.

Response

Provided that your request is valid, you will receive the information in line, in JSON format with HTTP code 200.

Code sample

<?php
// init
$host = 'https://secure.2checkout.com/action/taxes.php';

$merchantCode = 'YOUR_MERCHANT_CODE';
$key = 'YOUR_SECRET_KEY';
$signatureAlgo = 'sha256';

$jsonRpcRequest = array (
    'MERCHANT' => $merchantCode,
    'REQ_DATE' => (new DateTime("now", new DateTimeZone("UTC")))->format('Y-m-d H:i:s'),
    'PRODUCT_TAX_CATEGORY' => '997391d5-48d2-48d4-8914-6d48307b1307', // uuidProductTaxCategory received from API method getProductTaxCategories 
    'SHOPPER_TYPE' => '',// B2B, B2C, Both or empty
    'INCLUDE_ZIP_CODES' => '0'
);

$string = '';
foreach ($jsonRpcRequest as $value) {
    $string .= strlen($value) . $value;
}

$hash = hash_hmac($signatureAlgo, $string, $key);

$jsonRpcRequest['HASH'] = $hash;
$jsonRpcRequest['SIGNATURE_ALG'] = $signatureAlgo;

header('Content-Type: application/json');
echo call($jsonRpcRequest, $host, false);


function call($Request, $hostUrl, $Debug = true) {
    $curl = curl_init($hostUrl);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSLVERSION, 0);
    curl_setopt($curl, CURLOPT_VERBOSE, 1);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_PROXY, '');

    curl_setopt($curl, CURLOPT_POSTFIELDS, $Request);

    if ($Debug) {
        var_dump($Request);
    }

    $ResponseString = curl_exec($curl);
    if ($Debug) {
        var_dump($ResponseString);
    }

    if (!empty($ResponseString)) {
        return $ResponseString;
    } else {
        return null;
    }
}

Overview

The object below is returned directly or within a successful response from the following API requests:

• Retrieve eligible campaigns

Overview

The object below is returned directly or within a successful response from the following API requests:

• Retrieve eligible campaigns

Overview

Use the enterChurnCampaign method to confirm the campaign you want for the churn campaign process.

Parameters

Response

Request

<?php

require('PATH_TO_AUTH');

$subscriptionReference = '351D8F557E';
$campaignCode          = 'UGPPKKJY5L1LHBFPHKQ3';

$jsonRpcRequest = [
    'method' => 'enterChurnCampaign',
    'params' => [$sessionID, $subscriptionReference, $campaignCode],
    'id' => $i++,
    'jsonrpc' => '2.0'
];

var_dump(callRPC((object)$jsonRpcRequest, $host, true));

Overview

Use the acceptChurnCampaignDiscount method to confirm the campaign you want for the churn campaign process.

Parameters

Response

Request

<?php

require('PATH_TO_AUTH');

$subscriptionReference = '351D8F557E';
$campaignCode          = 'UGPPKKJY5L1LHBFPHKQ3';

$jsonRpcRequest = [
    'method' => 'acceptChurnCampaignDiscount',
    'params' => [$sessionID, $subscriptionReference, $campaignCode],
    'id' => $i++,
    'jsonrpc' => '2.0'
];

var_dump(callRPC((object)$jsonRpcRequest, $host, true));

Overview

Use the getEligibleChurnCampaigns method to retrieve all the eligible campaigns for a specific subscription with data in a specific language.

Parameters

Response

Request

<?php
require('PATH_TO_AUTH');
$subscriptionReference = '351D8F557E';
$languageCode          = 'en';
$jsonRpcRequest = [
    'method' => 'getEligibleChurnCampaigns',
    'params' => [$sessionID, $subscriptionReference, $languageCode],
    'id' => $i++,
    'jsonrpc' => '2.0'
];
var_dump(callRPC((object)$jsonRpcRequest, $host, true));