Overview

Add/import subscriptions in the 2Checkout system.

Include card data with your subscription import only if you contacted 2Checkout to enable this functionality for your account. Otherwise, the import process results in a failure. Contact 2Checkout or your account manager directly for more details.

ATTRIBUTES

 Card payment

Add credit/debit card details when importing subscriptions. 2Checkout uses payment information in the recurring billing process.

For imports of test subscriptions, use the credit card information from this article.`

Overview

Use the searchPromotions method to extract information on promotions you set up for your account.

Parameters

Response

Request

<?php

$host   = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/3.0/?wsdl", array(
    'location' => $host . "/soap/3.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;
}

$SearchOptions              = new stdClass();
$SearchOptions->Types       = array();
$SearchOptions->Types[0]    = 'REGULAR';
$SearchOptions->Types[1]    = 'RENEWAL';
$SearchOptions->Channel     = 'ECOMMERCE';
$SearchOptions->ProductCode = 'my_subscription_1';
$SearchOptions->Limit       = 10;
$SearchOptions->Page        = 1;


try {
    $Discounts = $client->searchPromotions($sessionID, $SearchOptions);
}

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

var_dump("Discounts", $Discounts);


?>

Overview

Use the getContents method to calculate the tax charge based on current session contents. Follow the steps below to learn how you can retrieve the VAT or sales tax amount:

1. Populate the Order object with information. 2Checkout needs the BillingDetails (object) information to calculate taxes. 
2. Use the getContents method to get info on all the products added to cart by the shopper in the current session.
3. The output of the getContents method is the Order session content object.
4. Under the Price, access information including for each product purchased. Find value added tax and sales tax details under the VAT parameter. 
5. Tax information is also available for the entire order object. Find value added tax and sales tax details under the VAT parameter.
6. Calculate the VAT/sales tax rates using the VAT and NetPrice values. 

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'usd';
$Order->Country = 'US';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->AffiliateId = NULL;
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1;
$Order->Items[0]->PriceOptions = NULL;
$Order->Items[0]->SKU = NULL;
$Order->Items[0]->Price = NULL;
$Order->Items[0]->CrossSell = NULL;
$Order->Items[0]->Trial = false;
$Order->Items[0]->AdditionalFields = NULL;
$Order->Items[0]->Promotion = NULL;
$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'FirstName';
$Order->BillingDetails->LastName = 'LastName';
$Order->BillingDetails->CountryCode = 'us';
$Order->BillingDetails->State = 'California';
$Order->BillingDetails->City = 'LA';
$Order->BillingDetails->Address1 = 'Address example';
$Order->BillingDetails->Address2 = NULL;
$Order->BillingDetails->Zip = '90210';
$Order->BillingDetails->Email = 'customer@email.com';
$Order->BillingDetails->Phone = NULL;
$Order->BillingDetails->Company = NULL;
$Order->DeliveryDetails = NULL;
$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'TEST';
$Order->PaymentDetails->Currency = 'usd';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '10.10.10.10';
$Order->PaymentDetails->PaymentMethod->RecurringEnabled = true;
$Order->PaymentDetails->PaymentMethod->CardNumber = "4111111111111111";
$Order->PaymentDetails->PaymentMethod->CardType = 'visa';
$Order->PaymentDetails->PaymentMethod->ExpirationYear = '2019';
$Order->PaymentDetails->PaymentMethod->ExpirationMonth = '12';
$Order->PaymentDetails->PaymentMethod->HolderName = 'John';
$Order->PaymentDetails->PaymentMethod->CCID = '123';
$Order->Promotions = NULL;
$Order->AdditionalFields = NULL;
$Order->LocalTime = NULL;
$Order->GiftDetails = NULL;

try {
    $CartContents = $client->getContents    ($sessionID, $Order);
}
catch (SoapFault $e) {
    echo "CartContents: " . $e->getMessage();
    exit;
}
var_dump("CartContents", $CartContents

Overview

Use A/B testing campaigns to compare purchase flow variations and determine the highest converting purchasing funnel. Test between multiple purchase flow types:

• Checkout with cart functionalities
• One page checkout without review
• One page checkout with review
• Checkout page
• Express Payments Checkout

Requirements & limitations

Parameters sent through buy links will overwrite campaigns variables. Campaigns will not start if the buy link has a parameter that overwrites an experiment variable.

Trial links generated without CART or CARD parameters are also taken into account by the A/B testing mechanism.

You can see in the table below that some links that you can generate via the Sales links area of the platform contain parameters such as CART=1, CARD=1 or CARD=2. Make sure to remove these parameters from the links your shoppers use. Otherwise, their interactions will not be taken into account by the purchase flows A/B test.

Important: 2Checkout updates the campaign results at hourly intervals. Please allow up to one hour for the statistics to completely refresh after running tests.

2Checkout recommends using simple links, such as https://secure.2checkout.com/order/checkout.php.

https://secure.2checkout.com/order/checkout.php?CART=1

https://secure.2checkout.com/order/checkout.php?CART=1&CARD=2

https://secure.2checkout.com/order/checkout.php?CART=1&CARD=1

https://secure.2checkout.com/order/checkout.php

Purchase flows scenario variants

• Include cart functionalities
• Include payment details
• Exclude review page

Shopping cart modifiers

• Include compact shopping cart fields
• Include express payments checkout

Note: The one page checkout without review and one page checkout with review flows have an identical behavior when the shopper uses PayPal for the payment.

By using these options, you can replicate the purchase flows available in the 2Checkout system.

• Checkout with cart functionalities: shopping cart, billing info, review order, payment details
• One page checkout without review: shopping cart, billing info, payment details, express payment checkout
• One page checkout with review: shopping cart, billing info, payment details, review order, express payment checkout
• Checkout page: cart content, billing info, review order, payment details

You can use all of the flows in conjunction with the Include compact shopping cart fields setting.

2Checkout allows you to compare the following purchase flow scenarios. The table below shows the scenarios that 2Checkout currently supports.

Example scenario 1

Let's say that you currently sell products/subscriptions using the One page checkout with review purchase flow, and you want to compare conversion rates with the One page checkout without review flow.

Requirements

Before kicking off an A/B test make sure that you create a comprehensive testing plan with clearly defined comparison scenarios and even clearer success metrics.

Setup

1. Go to the A/B Testing page and click the Campaigns tab.
2. Click Configure new campaign in the Purchase flows section. If you already have an existing campaign, click the Edit Campaign button.
3. Fill in the details of the new campaign, such as the campaign name, maximum number of tests and the date when the campaign should end. Hit the Add campaign button to create an empty campaign. If you already have an existing campaign, proceed to the next step.
4. For our example scenario, enable the Include cart functionalities and Include payments details options to define the One page checkout with reviewpurchase flow. This will act as the baseline control sample. Set 50% of the traffic to be redirected to this scenario - this means that 50% of all visitors that reach checkout will use the One page checkout with review flow.
5. Click Add Scenario.
6. Next, let's create the second scenario. Enable the Include cart functionalities, Include payments details and Exclude review page options to define the One page checkout without review purchase flow. This will act as our comparison version. Set the remaining 50% of traffic to be redirected to this scenario - this means that the remaining 50% of all visitors that reach checkout will use the One page checkout without review flow.
7. Click Add Scenario.
8. Click Save campaign.
9. Return to the A/B testing dashboard and find your campaign in the list.
10. Click Start Campaign to direct half of your shoppers to one scenario and half to the other.
11. Calculate the A/B testing statistical confidence to know when you can stop the A/B testing campaign. When you have gathered enough relevant data you can easily decide on the winning scenario.

Note: Keep in mind that the example above is only a demonstrative one. You'll need to configure your own A/B tests based on your own individual testing needs.

Example scenario 2

Let's say that you currently sell products/subscriptions using the One page checkout without review purchase flow, and you want to compare conversion rates using the compact shopping cart fields and express payments checkout.

Setup

1. Go to the A/B Testing page and click the Campaigns tab.
2. Click Configure new campaign in the Purchase flows section. If you already have an existing campaign, click the Edit Campaign button.
3. Fill in the details of the new campaign, such as the campaign name, maximum number of tests and the date when the campaign should end. Hit the Add campaign button to create an empty campaign. If you already have an existing campaign, proceed to the next step.
4. For our example scenario, enable the Include cart functionalities, Include payments details and Exclude review page options to define the One page checkout without review purchase flow. This will act as the baseline control sample. Set 34% of the traffic to be redirected to this scenario - this means that 34% of all visitors that reach checkout will use the One page checkout without review flow.
5. Click Add Scenario.
6. Let's create the second scenario now. Enable the Include cart functionalities, Include payments details, Exclude review page and Include compact shopping cart fields options to define the One page checkout without review purchase flow with compact shopping cart fields. Set 33% of the remaining traffic to be redirected to this scenario - this means that another 33% of all visitors that reach checkout will use this flow.
7. Click Add Scenario.
8. Now for the third scenario. Enable the Include cart functionalities, Include payments details, Exclude review page and Include express payments checkout options to define the One page checkout without review purchase flow with express payments checkout. Set the remaining 33% of the remaining traffic to be redirected to this scenario.
9. Click Add Scenario.
10. Click Save campaign.
11. Return to the A/B testing dashboard and find your campaign in the list.
12. Click Start Campaign to start splitting your visitors between scenarios.

Overview

Place an order using catalog products defined in your Control Panel, and collect the payment using PayPal.

Currency support

Check with Avangate support for a list of currencies available for PayPal. 

Parameters

Workflow

1. Create the order object. Use PAYPAL as the type of the PaymentDetails object and send the shopper email and a return URL as part of the PaymentMethod object. Place the order.
2. Once you place the order, Avangate logs it into the system. At this point in time, the status of the order is PENDING. Avangate responds with the Order information object.
3. Redirect shoppers to the RedirectURL from the Order information object you receive as response from Avangate.
4. Once shoppers log into their PayPal account and complete the transaction, they're redirected to the ReturnURL you set in the order object. Avangate also authorizes the order and updates the status to AUTHRECEIVED. 

Response

Request example

<?php

require ('PATH_TO_AUTH');

$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'usd';
$Order->Country = 'US';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->Affiliate = new stdClass();
$Order->Affiliate->AffiliateCode = 'Partner123'
$Order->Affiliate->AffiliateSource = 'MobilePlatform'
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1; 
$Order->Items[0]->PriceOptions = NULL;
$Order->Items[0]->SKU = NULL;
$Order->Items[0]->Price = NULL;
$Order->Items[0]->CrossSell = NULL;
$Order->Items[0]->Trial = false; 
$Order->Items[0]->AdditionalFields = NULL;
$Order->Items[0]->Promotion = NULL;

$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'FirstName';
$Order->BillingDetails->LastName = 'LastName';
$Order->BillingDetails->CountryCode = 'us';
$Order->BillingDetails->State = 'California';
$Order->BillingDetails->City = 'LA';
$Order->BillingDetails->Address1 = 'Address example';
$Order->BillingDetails->Address2 = NULL;
$Order->BillingDetails->Zip = '90210';
$Order->BillingDetails->Email = 'customer@email.com';
$Order->BillingDetails->Phone = NULL;
$Order->BillingDetails->Company = NULL;
$Order->DeliveryDetails = NULL;

$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'PAYPAL';
$Order->PaymentDetails->Currency = 'usd';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '91.220.121.21';
$Order->PaymentDetails->PaymentMethod->ReturnURL = 'http://yoururl.com';
$Order->PaymentDetails->PaymentMethod->Email= 'email@avangate.com';
$Order->AdditionalFields = NULL;
$Order->LocalTime = NULL;
$Order->GiftDetails = NULL;

try {
    $newOrder = $client->placeOrder($sessionID, $Order);
}
catch (SoapFault $e) {
    echo "newOrder: " . $e->getMessage();
    exit;
}

var_dump("newOrder", $newOrder);

Overview

This is a list of countries that are part of the European Economic Area (EEA). 

List of European Economic Area (EEA) Countries

Overview

Use this object to create new orders and collect payments from shoppers using products with dynamic information. 

Purchase types available are: PRODUCT, TAX, SHIPPING and COUPON. The surcharge defined in the pricing option is used for calculating the order renewal price, when applicable.

Supported payment methods

1. Credit/Debit cards: Visa, Visaelectron, MasterCard, Maestro, Amex, Discover, Dankort, Cartebleue, JCB. 2Checkout supports local Brazilian cards.
2. PayPal 
3. Free orders (no payment information required).
4. 2Pay.js

How to test?

Place test orders with dynamic product information by following the instructions from this article.

Requirements

Product code must be sent as null. The order currency must match with the payment currency, otherwise, an error is thrown. The isDynamic parameter of the Items object must be true.

Limitations

Placing an order with both catalog and dynamic product information is not possible. Recurring options can be set only for purchase type PRODUCT and TAX.

Parameters

Overview

Use the unassignPricingConfigurationOptionGroup method to remove a PricingOptionGroup from a PricingConfiguration.

Parameters

Response

bool(true)

Request

<?php

require ('PATH_TO_AUTH');

$pricingConfigurationCode = 'YOUR_PRICING_CONFIG_CODE';
$priceOptionsGroupAssigned = new stdClass();
$priceOptionsGroupAssigned->Code = 'STORAGE';
$priceOptionsGroupAssigned->Required = false;

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'unassignPricingConfigurationOptionGroup',
'params' => array($sessionID, $pricingConfigurationCode, $priceOptionsGroupAssigned)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

?>

Overview

Use this section to handle the renewal of your subscriptions.

Overview

Use the setSubscriptionUpgrade method to upgrade a subscription. 

Requirements

You can only upgrade subscriptions with automatic renewal enabled.

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 = "YOUR_MERCHANT_CODE";// your account's merchant code available in the 'System settings' area of the cPanel: https://secure.avangate.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.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;
}
$subscriptionReference = 'BE14FDCF37';
$ProductCode = 'my_subscription_123';
$Options = 'emailsupport;oneuser1';//case sensitive; include only price options codes (exclude spaces)
$customPrice = 1;
try {
    $upgradedSubscriptions = $client->setSubscriptionUpgrade($sessionID, $subscriptionReference, $ProductCode, $Options, $customPrice);
}
catch (SoapFault $e) {
    echo "upgradedSubscriptions: " . $e->getMessage();
    exit;
}
var_dump("upgradedSubscriptions", $upgradedSubscriptions);