Overview

Use the getProductCrossSellCampaigns method to extract information on all cross-sell campaigns triggered by the same primary product.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$ProductCode = 'subscr1';

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'getProductCrossSellCampaigns';
$jsonRpcRequest->params = array($sessionID, $ProductCode);
$jsonRpcRequest->id = $i++;

var_dump(" \n Cross-sell campaigns: \n", callRPC($jsonRpcRequest, $host));

Overview

1. Populate the Order object with information. Avangate 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
$host   = "https://api.avangate.com";
$client = new SoapClient($host . "/soap/6.0/?wsdl", array(
    'location' => $host . "/soap/6.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          = date('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;
}
 
var_dump($sessionID);
$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 = 'CC';
$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 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/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 = "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

Use the addPromotionSources method via SOAP API 4.0 to define new sources for an existing promotion.

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 this method to set an external reference for a partner order. This is helpful if you use unique identifiers in your own order management system and you want to mirror the IDs in the 2Checkout system.

Requirements

Use this method before placeOrder.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');  // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner
require ('PATH_TO_ADD_PRODUCT'); // addProduct example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/08Place_an_order/00Add_product_to_cart

$externalRef = 'NEW_REFERENCE';

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

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

require ('PATH_TO_PLACE_ORDER');

Errors

Overview

Use this method to send registration emails for a list of subscriptions.

Requirements

Parameters

Response

Request

<?php

require('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/02Authentication
require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner

$subscriptionReferencesList = array('REFERENCE_1', 'REFERENCE_2');
$email = 'YOUR_EMAIL_ADDRESS';
$language = 'YOUR_LANGUAGE';

try {
    $RegistrationEmail= $client->sendRegistrationEmail ($sessionID, $subscriptionReferencesList, $email, $language);
} catch (SoapFault $e) {
    Echo "REmail: " . $e->getMessage();
    exit;
}
var_dump ("REmail ", $RegistrationEmail);

Errors

Overview

Use the placeOrder method to create an order using physical/tangible products defined in your Control Panel and collect the payment using credit card based payment methods.

Parameters

Requirements

Add the product code of a tangible/physical product defined in your 2Checkout Control Panel. 

When placing orders for physical products, you can provide the shipping method that applies to the purchase in the API call, as part of the DeliveryInformation object.

Response

Request

<?php

require ('PATH_TO_AUTH');

$Order = new stdClass();
$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]->SubscriptionStartDate = NULL; //If empty or null, subscriptions become active when purchase is made.

$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'First';
$Order->BillingDetails->LastName = 'Last';
$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 = 'email@address.com';
$Order->BillingDetails->Phone = NULL;
$Order->BillingDetails->Company = NULL;
$Order->DeliveryDetails = NULL;

$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'CC';
$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->CCID = '123';
$Order->PaymentDetails->PaymentMethod->HolderName = 'John';
$Order->PaymentDetails->PaymentMethod->CardNumberTime = 83.21; // can be null - high value in seconds is a red flag for fraud attempts.
$Order->PaymentDetails->PaymentMethod->HolderNameTime = 13.35; // can be null - high value in seconds is a red flag for fraud attempts.
$Order->PaymentDetails->PaymentMethod->Vendor3DSReturnURL = "http://www.success.ro";
$Order->PaymentDetails->PaymentMethod->Vendor3DSCancelURL = "http://www.error.ro"; 


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

var_dump("newOrder", $Order);

Parameters

Overview

Migrate your subscription and customer credit card data from your or a third-party system and store it securely in the 2Checkout vault.

Availability

2Checkout Enterprise Edition accounts.

Contact 2Checkout Support directly to inquire about subscription and card migration costs.

Requirements

• PCI compliance. All entities involved in the process of migrating sensitive card information need to be PCI compliant. 2Checkout enjoys a Level 1 PCI DSS certification. Before moving forward with any data migration you need to contact 2Checkout Support directly for compliance.
• Data format. Read below for details of the PGP-encrypted CSV file structure.
• Valid import data. Filter data to migrate only active subscriptions and customers into the 2Checkout platform.
• Pre-migration checklist. Match all requirements on the pre-migration checklist.

Filter import data

To minimize the risk and rate of refunds/chargebacks, filter the import data, and communicate your customers to only migrate those who are aware that 2Checkout will process future recurring charges or manual payments.

Pre-migration checklist

eStore

• Configure the products for which you’re importing subscriptions using the 2Checkout Merchant Control Panel. Match the 2Checkout Product ID of configured items with the product ID of subscriptions you’re importing via the CSV file, or the import process will fail. Also, make sure the renewal settings are correctly configured for each product.
• Build a valid CSV file using the structure guidance described below, and include all mandatory fields.

Partner channel subscriptions

• On top of the requirements above, also configure partner details in the 2Checkout Control Panel and use their unique partner ID when importing new subscriptions.
• Merchants can see partner information at the subscription level so that they can identify this information for imported subscriptions as well.

Data format and structure

To import:

• Package the data as CSV (comma-separated values) file.
• Include the mandatory items described below on the header line and populate values where information is also required.

When importing subscriptions, you should keep in mind that the processing capacity of the browser supports about 2500  lines in the csv file, and anything more than this threshold might result in failure. Thus, we recommend that you import batches lower than 2500 lines.

Card data validation

The 2Checkout system handles syntax validation of card type, number, and expiration date. 2Checkout does not pre-authorize the cards during the import process. You cannot import credit/debit card info for non-recurring (lifetime) subscriptions.

Workflow

1. Contact 2Checkout Support with a request to start the migration process and follow through the compliance assessment process.
2. Either create or have the third-party you’re working with build the subscription data CSV file.
3. Upload the file to a designated SFTP account provided by 2Checkout.

PGP encryption

You must encrypt all transfer of sensitive payment data, including when working with 2Checkout to import card information. Use the following PGP public key:

-----BEGIN PGP PUBLIC KEY BLOCK-----

mQGNBGe2Q+8BDACgDrq5A2uQ2XnCD3j0da9mEolgxYNgAeTMWQgXZAUHA5PuzdpQ
7xFrni+kN6YnUTasraKabQgyreuQujX+Ysb/qqFXX6q1QuC8vNnC/c6W/aT8smfC
WzO5frnJGQaSoQCx/hXOXzZSLltKVJeD5CEC4GoK1KjjL9ihVdFcXW1KQm1ZsznK
fYOir62WUzYQBPy21Fppt6ssO846XdB189WACm4+RM4NUw5oZB/CnWWE63j/8paU
qvRFjrlMxMbvw/1/6S10jt46dvcQ99JRlS6u1UBrNvYJJoshmyFrr18YqMfepWhK
12SqKEQNced1Y1B4dPzz2PcNpT9ngTFES7931ObdFFj/cQemb0reb26oginXUMOT
PFdGtlGT1OYA7WuWVyGIExwlRZZG+nbE40NWnN+IN+uwYZCcfxsg7GDa3wUlLGO9
IGrT82kQ1WCVxiuKeVeWFf45YIeYmSF6ew+P0bZBrlaROiHvRZaS8jZv07uK7PGz
byZKdWzt+NvdY3kAEQEAAbQJTGVhZHBhZ2VziQHOBBMBCgA4FiEEqA2VzGx54wI9
yq0bFRQGLOEf0gAFAme2Q+8CGwMFCwkIBwIGFQoJCAsCBBYCAwECHgECF4AACgkQ
FRQGLOEf0gBvOgv/fmel1wu7Xl574tswwyBhVd+BLelorlk2FXh/pTGQVT7TksQ1
CVtnKhhHQM1VeQTtvPo2t3voesfuwJN2ydg5BpimGOo7CPXypVwUKrxzN0TfCuq+
QjXi0za/v1x7QDy3kWYD6RB3nv3a+3HOdsq/V4mce5HxDEnUWTmEFkdoDlLHuogU
qRCZZz5UOTfdJjx/afrhr5tOQ6msd8trv9jesX639wKqdiX0UxrbZE/C1X0DTbPw
jx7sa3oHIMkgvzDeR7Cldbb9qzwK6tzGWm9sx7LtV3GZecCyl+jSIrvSzV6nvg0a
OXHcclNev1chQ2kSMFA/5RnLY+qUsG8lttc65dtksiuAlJrMD1lsJzRwTbwp3tMD
4AkP2mDDuFWaM9/6llVp3rQEdhO1E0K+J9hVbvH5kNmdIe8PU0J8gMMZ0T/D2FWw
QtGE3kgqk5u2/h0zXOIm/3slOn4T376IWTaPhoCxS1UKGQSAw2xTdmtfm+PgYwKj
PV85gaBJ05kjqWG7uQGNBGe2Q+8BDACRBjFaTaTpQAtEB+4wCXKm9e/Mx6lNSbm1
N60Twt9wHRkkypSlYbkUKO9XhawGlc3a4DaNV1gvAmzXVoGUZ097lM3eP4dfErL4
9a2KzxAiD/Kzsg4q4WZJ1pzQF2AoxBwIET+90hezTYToshnb/cV3G0HZ0f13GIuq
i2Az7J5gLaZk2OzYs8/1VwzXYp3v9pCYLmuibCWU59Tod0XTsuJ6eI//ttMWAz4V
kV0wnDMVuudVw+EDsAb83yiDcpNGIFiIUsuZdInraguqdqE5csldpZqJW6biPdY+
ItziEPs0i5mjcvwxfOhKByWb6uBhz1rVgldfRcnS4rFKprGwPmXccROKVFgUU0k2
0jF5yghOtzR0lX+qU/sxNbXUwr9WGB+gkAMah+g6htFlkE73At4IWLmKws49hIPW
N6CRXH03GT2xdrN4NV5GrIyeJKmC1HfPMsbhSyZTBwcAsPcw7OpReKUte1ft2bSG
ZX9D/3Tf3cT1IOlKBcXPBUllZgcxXM0AEQEAAYkBtgQYAQoAIBYhBKgNlcxseeMC
PcqtGxUUBizhH9IABQJntkPvAhsMAAoJEBUUBizhH9IAieQL/1UBPs67mvU33rwi
vQr6QQckvKRxygl3AsWlSQKnbz8LU56Qaid+JvOFWEM+7qTL8DR5DubnMdD4bkY7
podDGKDUrscgHeNmKdfAINxIH/y0EcBM9IztRGpD3d9JmhK4N46W5RFPkIjExk1T
o0OrroUr5QlkNv2bmM/YS45/0DUp0+BP84Tfh6wEVwCFnPqIxlQdnQhLgFlJoKWO
lI5ws06y5PHorrHLQSyPY8OLhLrkQfiPjnREDhYSxiSaE8S65JRuPiABpus2GUhS
AcGSTfIahJPYPfoullMBxUta40BXlArEJvkQdQ+QVp8VwYCBmKIv0y5oR4Xr5/OC
sR+FcaU2K0fHiQI11sFy3WF4rMiRi7O38N6FM+DBL37iHAp3PGgUIjAICxnUl0fH
SPUvrd97PYp74CrQWwdxxS/mDSi7iMMjGToeqYTBsT+o9CFyLSf3LdSWVVIy7MsX
Ua7QrdvO8T9OQqzvBILK0qIxp8Dx2mK+4rKavjFNOR2wkHyrbg==
=Y5Ea
-----END PGP PUBLIC KEY BLOCK-----

Overview

Use the getAdditionalOrderField method to extract information about a specific additional field you set up for your account.

Parameters

Request

<?php
 
require ('PATH_TO_AUTH');

$fieldCode = 'YOUR_FIELD_CODE';
 
$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getAdditionalOrderField',
'params' => array($sessionID, $fieldCode)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));
 ?>

Response