Overview

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

Retrieve a pricing configuration by name            Retrieve a pricing configuration by code               Retrieve pricing configurations

Pricing configuration object

Overview

Use the getDisplayType method to extract information for the upselling display type for your campaigns. 

Request parameters

Response

The getDisplayType method will return the UpsellingDisplayType value with one of "overlay" or "interstitial".

Request sample

<?php 

          require ('PATH_TO_AUTH'); 

          try { 

            $upSellSettingsResponse = $client->getDisplayType($sessionID); 

          } catch (SoapFault $e) { 

            echo  $e->getMessage(); 

          } 

Overview

Starting with 2Checkout API 5.0, search methods are including the option of pagination. Pagination has been developed for decreasing the request loading time, while allowing you to better handle the returning responses.

How it works?

Pagination works on all the search methods existing on 2Checkout API 5.0. The default pagination behavior is to display page 1 with 10 results. The maximum number of items displayed on a single page is 200.

Parameters

To use pagination, include the Pagination object inside the search method call, using the parameters below:

Response

The response of search methods that are including pagination will contain a new object, with the following parameters:

Sample request

The below PHP sample includes a search method for subscriptions.

<?php

require('PATH_TO_AUTH');

$SubscriptionSearch = new stdClass();
$SubscriptionSearch->CustomerEmail  = 'email@avangate.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->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->Pagination = new stdClass();
$SubscriptionSearch->Pagination->Page = 1; // set the number of pages for the response
$SubscriptionSearch->Pagination->Limit = 200; // set the limit for the values from the response

try {
    $accountSubscriptions = $client->searchSubscriptions($sessionID, $SubscriptionSearch);
}
catch (SoapFault $e) {
    echo "accountSubscriptions: " . $e->getMessage();
    exit;
}
var_dump("accountSubscriptions", $accountSubscriptions);

Overview

Use the setProductStatus method to enable / disable subscription plans/products for your account.

Parameters

Response

bool(true)

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;
}

$ProductCode = 'ABC4643116';

try {
    $ProductStatus = $client->setProductStatus($sessionID, $ProductCode, true); // TRUE to enable a product - FALSE to disable a product
}

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

var_dump("ProductStatus", $ProductStatus);

?>

Overview

3D Secure is a system designed to increase the security of online transactions using cards by checking customer identities before allowing them to finalize a purchase. 3D Secure works by redirecting customers to pages provided by their banks, where they need to enter additional security tokens or password to trigger the completion of the charge. By using 3D Secure, you get additional protection from liability for fraudulent card payments, with customers having to go through an extra layer of authentication.

Description

Dynamic 3D Secure is based on the 3D Secure service offered by Visa and MasterCard, which is an additional security layer for authenticating cardholders online. 2Checkout uses Dynamic 3D secure to bring increased transaction acceptance levels on a per-country basis and extra protection against fraudulent purchases.

Availability

All 2Checkout accounts.

Dynamic 3D Secure workflow

Based on a set of specific filters and corresponding thresholds, 2Checkout enables or disables 3D Secure in real-time for online transactions. This approach provides a seamless payment experience for low-risk shoppers and optimized conversion rates for your business.

The filters used to determine whether or not 3D Secure should be enabled include:

• Card issuing country
• Billing country
• IP country
• Transaction amount

2Checkout enables 3D Secure for transactions which it evaluates and flags with a high degree of risk, based on specific filter thresholds. Safe transactions go through without 3D Secure.

2Checkout also offers the possibility to disable 3D Secure for all transactions in a specific country, bypassing all the filters. Contact 2Checkout to inquire about switching off Dynamic 3D Secure for your account. 

Benefits

2Checkout uses Dynamic 3D Secure to bring increased transaction acceptance levels and extra protection against fraudulent purchases. The added value Dynamic 3D Secure brings to the table consists in real-time transaction evaluation methods that determine whether or not 3D Secure should be enabled.

Dynamic 3D Secure improves the overall shopping experience on multiple levels:

• Increased authorization rates - tests have shown that 3D Secure can have an overwhelmingly positive impact in specific countries.
• Mitigated fraud risks - using 3D Secure for risky transactions decreases fraud rate.
• Fewer chargebacks - the use of 3D Secure can reduce the number of chargebacks in situations such as fraudulent or unrecognized transactions.

Overview

2Checkout sends out the electronic delivery email automatically to fulfill orders - delivering binary keys, activation codes, Download Software Insurance details or product files to your shoppers.

As of July 13th, 2016, you can use a redesigned template complete with fresh content. The new template has replaced the previous electronic delivery email, but any customization you have in place, either in terms of styling or content, continues to be available.

Availability

All 2Checkout accounts.

What is the purpose of this email?

2Checkout sends the electronic delivery email for those products where you set fulfillment to be performed through 2Checkout delivery.

Email content

Depending on what actions need to be performed by your clients to receive access to your products, the email includes one or several of the following:

1. Product/Subscription plan information.
2. Activation keys/codes accompanied by short descriptions.
3. Downloadable product files, and download insurance service.
4. Technical and payment support contact details.

Sample

Is this the only email my shoppers receive after placing an order?

2Checkout can send the electronic delivery email either standalone or combined with the payment receipt notification (in one single email).

Depending on your account's setup, for each order containing at least one product configured with 2Checkout delivery your shoppers can receive:

• Default: One email containing both the payment receipt and the electronic delivery messages
• Two email notifications: The payment receipt and the electronic delivery messages, separately
• Three email notifications: An order confirmation email, plus the payment receipt and the electronic delivery messages, separately

Contact 2Checkout to change your default configuration if you find another setup better suited for your customers.

Preview and test email

Navigate to the Email template manager section to:

• Preview and test current templates for emails sent to your shoppers
• Customize the header and the footer sections by creating custom templates you can assign to your emails

Access the electronic delivery email under the section with the same name.

Why don't I see the new template for the electronic delivery email?

The redesigned template for the electronic delivery email has automatically replaced default templates.

If your preview of electronic delivery email does not show the new template, you are most probably using a customized version, that includes content and/or styling your company requested at a certain point in time.

You can compare the above sample to your current template and send us an email if you decide the new one suits your business needs better. We will work with you on the switch.

Overview

2Checkout supports the customization of the Partner Control Panel user interface, enabling you to offer a unified purchase and post-sale Channel Manager experience by tailoring the Control Panel to match your brand as well as the look and feel of your online store and shopping cart.

Benefits

• Control the post-sale partner service platform, focusing it only on interactions they have with your company.
• Build a personalized Channel Manager portal experience for your customers complemented by branding and a design aligned with the look and feel of your website.

Requirements

• Enterprise Edition Suite. Customization is available for 2Checkout accounts running the Enterprise Edition.
• Channel Manager. Contact 2Checkout directly if you'd like to start taking advantage of the platform in your relationship with customers.

Partner Control Panel customization options

• Default. The Default version of the Partner Control Panel is available to all your partners unless you opt to take advantage of personalization.
• Simple customization. The simplest way to personalize the design of the Partner Control Panel is to use the Simple customization options at your disposal to change the characteristics of standard Channel Manager user interface elements.

Edit Partner Control Panel interface

Follow the steps below to customize the Partner Control Panel interface.

1. Go to Setup -> Interface templates.
2. Select the Partners tab.
3. The Default template option is selected provided that no personalization was introduced. You can select Simple customization instead.

Simple customization

• Branding. Custom Partner Control Panel designs are branded experiences, featuring the same logo as the one uploaded in the 2Checkout Control Panel, under Account settings, in the Company Logo area.
• Styles. You also control the color styles for the Partner Control Panel text, icons, page title and subtitle, links (for new, hover and visited), for tabs (selected, hover) and tab text, as well as for the table header background and text. All you need is the hexadecimal codes for the new color you want to implement, but a default basic color selector is also available. Taking advantage of the personalization options, you can redesign the 2Checkout Partner Control Panel.

Overview

Use the getSubscriptionUsages method SOAP API 6.0 to filter and retrieve usages for a subscription.

Request Parameters

Request Sample

<?php
require ('PATH_TO_AUTH'); // authentication call
$subscriptionReference = 'EF4B51535B';
$usageReference = 120010492176;

try {
    $subscriptionUsageRequest = new stdClass();
    $subscriptionUsageRequest->SubscriptionReference = $subscriptionReference;
    $subscriptionUsageRequest->Page = 1;
    $subscriptionUsageRequest->Limit = 10;
    $subscriptionUsageRequest->IntervalStart = '2020-04-09 16:40:00';
    $subscriptionUsageRequest->IntervalEnd = '2020-04-12 15:40:00';
    $response = $client->getSubscriptionUsages($sessionID, $subscriptionUsageRequest);
    var_dump($response);
} catch (SoapFault $ex) {
    $faultname = (isset($ex->faultname)) ? " $faultname" : '';
    echo "[$ex->faultcode]$faultname: $ex->faultstring" . PHP_EOL;
}

exit;

Response 

The getUsages method via SOAP APIv6 returns the Usage object when successful.

class stdClass#3 (2) {
      public $Items =>
      array(1) {
        [0] =>
        array(8) {
          'UsageReference' =>
          string(12) "120011114371"
          'SubscriptionReference' =>
          string(10) "67F3AD6A32"
          'OptionCode' =>
          string(6) "USG_MN"
          'UsageStart' =>
          string(19) "2020-07-06 12:00:00"
          'UsageEnd' =>
          string(19) "2020-07-07 12:00:00"
          'Units' =>
          int(7)
          'Description' =>
          string(15) "Response sample"
          'RenewalOrderReference' =>
          int(0)
        }
      }
      public $Pagination =>
      class stdClass#4 (3) {
        public $Page =>
        int(1)
        public $Limit =>
        int(10)
        public $Count =>
        int(1)
      }
    }

Error Handling

The below errors are returned when the getUsages method via SOAP APIv6 is unsuccessful.

Overview

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

Retrieve session content                              Retrieve contents with prefill                                         Retrieve VAT or sales tax

Session contents object