Overview

Extract information on your account’s subscriptions. Use the searchSubscriptions method to retrieve details about your account’s subscriptions, based on a set of filters.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$SubscriptionSearch = new stdClass();
$SubscriptionSearch->CustomerEmail  = 'example@email.com';
$SubscriptionSearch->DeliveredCode = null;
$SubscriptionSearch->AvangateCustomerReference = null;
$SubscriptionSearch->ExternalCustomerReference = null;
$SubscriptionSearch->Aggregate = false;
$SubscriptionSearch->SubscriptionEnabled = null; //true false null
$SubscriptionSearch->RecurringEnabled = null; // true - autorenewal, false - manual renewal, null = both(default)
$SubscriptionSearch->ProductCodes = null; //array('Product_Code1', 'Product_Code2');
$SubscriptionSearch->CountryCodes = null;//array ('au')
$SubscriptionSearch->PartnerCode = null;
$SubscriptionSearch->PurchasedAfter = null;
$SubscriptionSearch->PurchasedBefore = null;
$SubscriptionSearch->ExpireAfter = null;
$SubscriptionSearch->ExpireBefore = null;
$SubscriptionSearch->LifetimeSubscription = null;
$SubscriptionSearch->Type = 'regular'; //'trial', 'regular', 'regularfromtrial'
$SubscriptionSearch->TestSubscription = null; // true, false, null = both(default) $SubscriptionSearch->Page = 1;$SubscriptionSearch->Limit = 25;
$SubscriptionSearch->Page = 1;
$SubscriptionSearch->Limit = 10;

$jsonRpcRequest = array (
'method' => 'searchSubscriptions',
'params' => array($sessionID, $SubscriptionSearch),
'id' => $i++,
'jsonrpc' => '2.0');

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

Overview

Use the createCustomer method to add the details of a customer entity into the 2Checkout system. By default, customer status is Inactive until you assign a specific subscription to the customer. Following that action, customer status reflects the status of the attached subscription(s).

Parameters

Response

Request

<?php
$host   = "https://api.2checkout.com";
$client = new SoapClient($host . "/soap/4.0/?wsdl", array(
    'location' => $host . "/soap/4.0/",
    "stream_context" => stream_context_create(array(
        'ssl' => array(
            'verify_peer' => false,
            'verify_peer_name' => false
        )
    ))
));

function hmac($key, $data)
{
    $b = 64; // byte length for md5
    if (strlen($key) > $b) {
        $key = pack("H*", md5($key));
    }
    
    $key    = str_pad($key, $b, chr(0x00));
    $ipad   = str_pad('', $b, chr(0x36));
    $opad   = str_pad('', $b, chr(0x5c));
    $k_ipad = $key ^ $ipad;
    $k_opad = $key ^ $opad;
    return md5($k_opad . pack("H*", md5($k_ipad . $data)));
}
$merchantCode = "YOUR_MERCHANT_CODE";// your account's merchant code available in the 'System settings' area of the cPanel: https://secure.2checkout.com/cpanel/account_settings.php
$key = "YOUR_SECRET_KEY";// your account's secret key available in the 'System settings' area of the cPanel: https://secure.2checkout.com/cpanel/account_settings.php
$now          = gmdate('Y-m-d H:i:s'); //date_default_timezone_set('UTC')
$string = strlen($merchantCode) . $merchantCode . strlen($now) . $now;
$hash   = hmac($key, $string);
try {
    $sessionID = $client->login($merchantCode, $now, $hash);
}
catch (SoapFault $e) {
    echo "Authentication: " . $e->getMessage();
    exit;
}
$newCustomer = new stdClass();
$newCustomer->2checkoutCustomerReference = null;
$newCustomer->ExternalCustomerReference = 'ThisIsATestReference123456';
$newCustomer->FirstName = 'NewCustomer';
$newCustomer->LastName = 'NewCustomerLastName';
$newCustomer->Company = null;
$newCustomer->FiscalCode = null;
$newCustomer->Address1 = 'Address';
$newCustomer->Address2 = null;
$newCustomer->City = 'LA';
$newCustomer->Zip = '90210';
$newCustomer->CountryCode = 'us';
$newCustomer->Phone = null;
$newCustomer->Fax = null;
$newCustomer->Email = 'newcustomer@email.com';
$newCustomer->ExistingCards = null;
$newCustomer->Enabled = null;
$newCustomer->Trial = null;
$newCustomer->Language = 'en';
try {
    $newCustomerInfo = $client->createCustomer($sessionID, $newCustomer);
}
catch (SoapFault $e) {
    echo "newCustomerInfo: " . $e->getMessage();
    exit;
}
var_dump("newCustomerInfo", $newCustomerInfo);

Overview

Parameters

Response

Request

<?php 

class Client
{
    protected static $merchantCode;
    protected static $loginDate;
    protected static $hash;
    protected static $baseUrl;
    protected static $callCount = 0;
    protected static $sessionId = '';

    protected static $client;

    public static function setCredentials($code, $key)
    {
        static::$merchantCode = $code;
        static::$loginDate = gmdate('Y-m-d H:i:s');
        static::$hash = hash_hmac('md5', strlen($code) . $code . strlen(static::$loginDate) . static::$loginDate, $key);
        static::$sessionId = static::login();
    }

    public static function setBaseUrl($url)
    {
        static::$baseUrl = $url;
    }

    public static function login()
    {
        $client = static::getClient();
        return $client->login(static::$merchantCode, static::$loginDate, static::$hash);
    }

    public static function __callStatic($name, $arguments = array())
    {
        $client = static::getClient();

        array_unshift($arguments, static::$sessionId);
        $response = call_user_func_array(array($client, $name), $arguments);

        return $response;
    }

    protected static function getClient()
    {
        $opts = array(
            'http'=> ['user_agent' => 'PHPSoapClient'],
            'ssl' => [
                'verify_peer' => false,
                'verify_peer_name' => false,
            ],
        );

        if (null === static::$client) {
            static::$client = new \SoapClient(static::$baseUrl . '?wsdl', [
                'location' => static::$baseUrl,
                'cache_wsdl' => WSDL_CACHE_NONE,
                'stream_context' => stream_context_create($opts),
            ]);
        }

        return static::$client;
    }
}

Client::setBaseUrl('https://api.avangate.com/soap/3.1/');
Client::setCredentials('YOUR_MERCHANT_CODE', 'YOUR_SECRET_KEY');
Client::login();

$promotionCode = 'YOUR_PROMOTION_CODE'; // code of the promotion that you want to update
$sources = ['source1', 'source2']; // array of sources to add to the promotion

$response = Client::addPromotionSources($promotionCode,$sources); // Set the promotion discount to the existing promotion
var_dump($response);

Overview

Use the searchProposals method via SOAP APIv6 to find a specific proposal or quote.

Request parameters

Request sample

<?php

require ('PATH_TO_AUTH');

$searchParameters = new stdClass();
$searchParameters->Name = "My Proposal Name";
$searchParameters->Email = "example@email.com";
$searchParameters->CreatedBy = "createUser";
$searchParameters->ModifiedBy = "modifyUser";
$searchParameters->Source = "MERCHANT_API";
$searchParameters->CreatedAfter = "2020-01-01T00:00:00+00:00";
$searchParameters->CreatedBefore = "2020-12-31T23:59:59+00:00";
$searchParameters->ModifiedAfter = "2020-01-01T00:00:00+00:00";
$searchParameters->ModifiedBefore = "2020-12-31T23:59:59+00:00";
$searchParameters->Locked = false;
$searchParameters->Offset = 0;
$searchParameters->Limit = 10;

try {
    $results = $soapClient->searchProposals($sessionID, $searchParameters);
    echo "Search results: </br>", 
    var_dump($results);
}
catch (SoapFault $e) {
    echo "Could not search proposals: " . $e->getMessage();
    exit;
}

Response

The searchProposals call via SOAP APIv6 returns a list of proposal objects.

Overview

We are continuously working on enhancing our products and services to help you convert every purchase into a satisfied customer and maximize your revenue no matter where you are selling. That is why we have made minor changes with a significant impact on your conversion rates to the Convert Plus shopping cart.

Based on the latest A/B test results aimed at boosting the in-cart conversion rates, we’ve updated the existing ConvertPlus default template and performed the following changes:

• Adjusted fonts, colors, buttons, and form fields
• Added coupons & display promotion in the shopping cart
• Displayed the product short description in the shopping cart
• Updated the billing flow & payment method selection

Recommended resources

Availability

Changes apply to the following cart templates:

• ConvertPlus - default template
• Custom ConvertPlus templates (based on the ConvertPlus default template), customized via the Merchant Control Panel cart editor or via 2Checkout Professional Services

Some of the UI changes also apply to the ConvertPlus templates ("One column with payment buttons", "2Checkout Marketplace Shopping Cart"), and InLine cart templates in order to offer you a consistent checkout flow.

Workflow

All templates from all categories listed above are updated automatically with no input from your side. Also, all existing simple and advanced customizations are applied to the updated templates (if any).

ConvertPlus Layout Updates

Overall look & feel: adjustments of fonts, colors, buttons, form fields

By displaying your customers’ favorite payment methods, you reassure them that they can proceed with the purchase:

• We’ve refreshed the overall look and feel of the shopping cart and made it highlight the most important fields in a clean and simple way, for improved customer experience.
• We’ve updated the payment method field by adding badges of the most popular credit card networks, depending on the area in which your customer is located.

Product short description and promotion field

The products' short descriptions and the promotion field are clearly displayed in the updated template to improve the checkout flow experience of your shoppers. 

• We’ve added product description in the summary section
• We’ve optimized the display of the coupon code link and made it less intrusive 

Billing and payment information section

The billing section is one of the most important in the checkout flow. Your customers need to feel safe when adding their personal information.

• We’ve updated the billing information section, made the security code pop-up tooltip more comprehensive, and added simplified, easy to understand graphics.

Payment Confirmation Page

Every transaction is seamless and secure, so your customers can have a smooth transition to the final step of the purchase funnel, the “Payment Confirmation Page”. 

• We’ve updated the elements on the payment confirmation page, so customers can be reassured that their payment was processed securely and successfully.

Sell Smart with Convert Plus With a seamless look and feel, Convert Plus is 2Checkout’s most optimized ordering engine. Built by using the most advanced technologies, our ordering engine is maximizing customer input during the payment process and increases your cart's conversion rates, no matter what market you are targeting. Feel free to reach us at supportplus@2checkout.com for any question related to the Convert Plus update.

Overview

Depending on your IPN settings, notifications contain all or a subset of the available parameters.

2Checkout sends IPN parameters exemplified in this article.

 IPN Parameters

[CUSTOM_PRICE] => Array

(

[31029265] => Array

(

[H17120HBAY] => Array

(

[AMOUNT] => 80

[TYPE] => NET

[CURRENCY] => USD

[SOURCE_NAME] => custom price regular

[SOURCE_TYPE] => PROMOTION

[DISCOUNT_VALUE] => 20

[DISCOUNT_TYPE] => FIXED

[DISCOUNT_CURRENCY] => USD

)


)


)

Overview

InLine Checkout acts as an iframe that opens on your website, enabling you to receive payments without redirecting your customers to a third party checkout.

Integrate InLine Checkout and:

• Offer your customers the possibility of purchasing using mobile devices with a responsive cart design, which renders well on a variety of devices and screen sizes.
• Improve your localization strategy, with a cart translated into 29 languages, and +130 transactional currencies for displaying the price.
• Minimize the customer effort during the purchase by passing the collected billing/shipping information to InLine Checkout.

InLine Checkout integrates ideally with shopping cart applications that collect customer billing and shipping information, allowing you to pass that information over to the cart and minimize customer's efforts during the payment process.

However, you can easily switch to a Multi-Step InLine Checkout flow if some of your customers would rather stick to a step-by-step payment process and fill-in their order details on separate cart pages.

Availability

InLine Checkout is available for accounts that have ConvertPlus enabled on their account. Contact 2Checkout for activation.

Features

We are continuously working on improving the InLine Checkout experience. Read here the full list of features supported by the InLine Checkout.

Dynamic product information

InLine Checkout enables you to receive payments without having products defined in your 2Checkout Control Panel. Send the product information dynamically to InLine Checkout, and receive payments without the need for a product catalog in 2Checkout.

How to integrate InLine Checkout

To integrate InLine Checkout with your shopping cart, follow the steps below.

1. Generate and insert the JavaScript code in your eCommerce website by following these steps:

• Go to Setup → Generate links area
• Click the InLine Checkout tab.
• Copy the JavaScript code snippet generated by our platform (see the code sample below) and paste it into your eCommerce website (you can paste it either inside the <head> tag or inside the page body right before the closing </body> tag of your HTML page)

You can choose one of the scripts below according to your preferred cart-flow length:

One-Step InLine:

<script> 

    (function (document, src, libName, config) { 

        var script             = document.createElement('script'); 

        script.src             = src; 

        script.async           = true; 

        var firstScriptElement = document.getElementsByTagName('script')[0]; 

        script.onload          = function () { 

            for (var namespace in config) { 

                if (config.hasOwnProperty(namespace)) { 

                    window[libName].setup.setConfig(namespace, config[namespace]); 

                } 

            } 

            window[libName].register(); 

        }; 


        firstScriptElement.parentNode.insertBefore(script, firstScriptElement); 

    })(document, 'https://secure.2checkout.com/checkout/client/twoCoInlineCart.js', 'TwoCoInlineCart',{"app":{"merchant":"XXXXXX","iframeLoad":"checkout"},"cart":{"host":"https:\/\/secure.2checkout.com","customization":"inline-one-step"}}); 

</script> 

Multi-Step InLine:

<script> 

    (function (document, src, libName, config) { 

        var script             = document.createElement('script'); 

        script.src             = src; 

        script.async           = true; 

        var firstScriptElement = document.getElementsByTagName('script')[0]; 

        script.onload          = function () { 

            for (var namespace in config) { 

                if (config.hasOwnProperty(namespace)) { 

                    window[libName].setup.setConfig(namespace, config[namespace]); 

                } 

            } 

            window[libName].register(); 

        }; 

        firstScriptElement.parentNode.insertBefore(script, firstScriptElement); 

    })(document, 'https://secure.2checkout.com/checkout/client/twoCoInlineCart.js', 'TwoCoInlineCart',{"app":{"merchant":"XXXXXX","iframeLoad":"checkout"},"cart":{"host":"https:\/\/secure.2checkout.com","customization":"inline"}}); 

</script> 

Your merchant code (you can find it in your merchant Control Panel, Dashboard → Integrations → Webhooks and API → API section) is automatically added by the system when you generate the JavaScript code library shown above, in the XXXXXXX string.

After you integrate the InLine Checkout JavaScript code in your HTML page, you get access to the library that allows you to add products, control billing and shipping details, and start the checkout process (see the JavaScript API reference here).

2. Add a buy button on your website.

• Navigate to the merchant Control Panel → Setup → Generate links
• Click on the InLine Checkout tab
• Select a product from the drop-down list in the 'Select one or more products' section 
• Provide the desired quantity in the “Quantity settings” section 
• Click on the Generate code button at the bottom of the page 
• Copy the link and paste it into your HTML page

3. Start the Checkout process. Starting the checkout process will display the payment overlay and the inline cart on your website.

Sample request

The below request represents a basic use of InLine Checkout, that allows your users to finalize purchases directly from your website via a secure payment form.

TwoCoInlineCart.setup.setMerchant('merchantCode'); // your Merchant code

TwoCoInlineCart.products.add({
    code: 'the-2co-product-code',
    quantity: 3
}); // add products to cart

TwoCoInlineCart.cart.checkout(); // start checkout process

Overview

Use the Cart object in order to set the return method of the InLine cart by calling theTwoCoInlineCart.cart.setReturnMethod({url, type})method.

Use case

1. Add an HTML link or button on your page like the one below.
2. Create a JavaScript click handler to execute the Inline Client desired methods.
3. Use theTwoCoInlineCart.products.add( {code, quantity, options})method to prepare your catalog product.
4. In order to set currency use TwoCoInlineCart.cart.setCurrency(currency-code).
5. In order to define the return method callTwoCoInlineCart.cart.setReturnMethod({url, type}).
6. You can see below a signature token request payload for this example. A success response contains a JSON with the property “signature“ which needs to be used at the next step to set the signature using the TwoCoInlineCart method.

{
    "merchant": "AVLRNG",
    "currency": "USD",
    "products": [
        {
            "code": "74B8E17CC0"
        }
    ],
    "return-method": {
        "type": "redirect",
        "url": "http://my-test-site.com/return-url"
    }
}

The above payload will generate the signature c05c712e7c14a23a425b799d39c7304bcc1715c6e903513da57f47fc164b93f9.

7. Use the TwoCoInlineCart.cart.setSignature('c05c712e7c14a23a425b799d39c7304bcc1715c6e903513da57f47fc164b93f9') method to set the signature.

8. Use theTwoCoInlineCart.cart.checkout()method to show the cart on your page.

Sample request

HTML

<a href="#" class="btn btn-success" id="buy-button">Buy now!</a>

Javascript

window.document.getElementById('buy-button').addEventListener('click', function() {
  TwoCoInlineCart.cart.setCurrency('USD');
  TwoCoInlineCart.products.add({
    code: "74B8E17CC0"
  });
  TwoCoInlineCart.cart.setReturnMethod({
    type: 'redirect',
    url : 'http://my-test-site.com/return-url'
  });
  TwoCoInlineCart.cart.setSignature('c05c712e7c14a23a425b799d39c7304bcc1715c6e903513da57f47fc164b93f9');
  TwoCoInlineCart.cart.checkout();
});

Demo

After setting the return method in the InLine cart using the above method, your cart should look like this:

Overview

Use the getPromotion method to extract information on a promotion you set up for your account.

Parameters

Response

Request

<?php

$host   = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/4.0/?wsdl", array(
    'location' => $host . "/soap/4.0/",
    "stream_context" => stream_context_create(array(
        'ssl' => array(
            'verify_peer' => false,
            'verify_peer_name' => false
        )
    ))
));


function hmac($key, $data)
{
    $b = 64; // byte length for md5
    if (strlen($key) > $b) {
        $key = pack("H*", md5($key));
    }
    
    $key    = str_pad($key, $b, chr(0x00));
    $ipad   = str_pad('', $b, chr(0x36));
    $opad   = str_pad('', $b, chr(0x5c));
    $k_ipad = $key ^ $ipad;
    $k_opad = $key ^ $opad;
    return md5($k_opad . pack("H*", md5($k_ipad . $data)));
}

$merchantCode = "YOURCODE123"; //your account's merchant code available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$key          = "SECRET_KEY"; //your account's secret key available in the 'System settings' area of the cPanel: https://secure.avangate.com/cpanel/account_settings.php
$now          = gmdate('Y-m-d H:i:s'); //date_default_timezone_set('UTC')

$string = strlen($merchantCode) . $merchantCode . strlen($now) . $now;
$hash   = hmac($key, $string);

try {
    $sessionID = $client->login($merchantCode, $now, $hash);
}

catch (SoapFault $e) {
    echo "Authentication: " . $e->getMessage();
    exit;
}

$PromotionCode = '123456789c'; //case sensitive
 
try {
    $Discount = $client->getPromotion($sessionID, $PromotionCode);
} 
catch (SoapFault $e) {
    echo "Discount: " . $e->getMessage();
    exit;
}
 
var_dump("Discount", $Discount);

?>

Overview

Use the setRenewalNotificationStatus method to subscribe or unsubscribe shoppers from subscription renewal notifications.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';
$status = false;

$jsonRpcRequest = array (
'method' => 'setRenewalNotificationStatus',
'params' => array($sessionID, $subscriptionReference, $Status),
'id' => $i++,
'jsonrpc' => '2.0');

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