Overview

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

Retrieve a customer

Customer object

Attributes

Overview

Use setPromotionDiscount to set a percentage based promotion discount.

Parameters

Response

Request

<?php

function callRPC($Request, $host, $Debug = true) {
    $curl = curl_init($host);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_VERBOSE, true);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    curl_setopt($curl, CURLOPT_SSLVERSION, 0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));
    $RequestString = json_encode($Request);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $RequestString);
    if ($Debug) {
        $RequestString;
    }
    $ResponseString = curl_exec($curl);
    if ($Debug) {
        $ResponseString;
    }
    if (!empty($ResponseString)) {
        var_dump($ResponseString);
        $Response = json_decode($ResponseString);
        if (isset($Response->result)) {
            return $Response->result;
        }
        if (!is_null($Response->error)) {
            var_dump($Request->method, $Response->error);
        }
    } else {
        return null;
    }
}

$host = 'https://api.avangate.com/rpc/3.1/';

$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

$string = strlen($merchantCode) . $merchantCode . strlen(gmdate('Y-m-d H:i:s')) . gmdate('Y-m-d H:i:s');
$hash = hash_hmac('md5', $string, $key);

$i = 1;

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'login';
$jsonRpcRequest->params = array($merchantCode, gmdate('Y-m-d H:i:s'), $hash);
$jsonRpcRequest->id = $i++;

$sessionID = callRPC($jsonRpcRequest, $host);

// Promotion code assigned to the promotion you want to update
$promotionCode = '';

$promotionDiscount = new stdClass;
$promotionDiscount->Type = 'PERCENT';
$promotionDiscount->Value= '25';

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

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

// // Define single coupon object
// $promotionCoupon = new stdClass;
// $promotionCoupon->Type = 'SINGLE';
// $promotionCoupon->Code = 'YOUR_CODE_HERE';

// Define multiple coupon object
// $promotionCoupon = new stdClass;
// $promotionCoupon->Type = 'MULTIPLE';
// $promotionCoupon->Codes = ['YOUR_CODE_1', 'YOUR_CODE_2'];

$response = Client::updatePromotionCoupon ($promotionCode,$promotionCoupon); // Update existing coupons
var_dump($response);

Overview

Use the getPriceOptionGroup method to extract information about a specific price option group that you configured.

Parameters

Request

Request

<?php

require ('PATH_TO_AUTH');

$groupCode = 'USERS';

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

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

Overview

Use the setCrossSellSettings method to customize the way your cross-sell campaigns are displayed in the shopping cart.  

Request parameters

Response

The response of the setCrossSellSettings method is the input object with the settings updated. 

Request sample

<?php 
require ('PATH_TO_AUTH'); 
 
try { 
    $sessionID = $client->login($merchantCode, $date, $hash); 
    $setCrossSellSettingResponse = $client->setCrossSellSettings($sessionID, (object)[ 
        'maxThumbSize' => 60, 
        'displayProductsMax' => 5, 
        'displayShortDescription' => false, 
    ]); 
} catch (SoapFault $e) { 
    echo  $e->getMessage(); 
} 

Overview

2Checkout has upgraded the Subscription search (formerly Customers (License Management)) area of the Control Panel introducing major changes to support more granularity and control over the data returned, increasing efficiency, and providing you with better insight into the evolution of subscriptions associated with the products you're selling.

Subscription search returns results in real-time, enabling you to closely monitor order evolution.

Basic filters

1. Product filter. Select specific products, or get information on all your offerings.
2. Subscription status:
   
   • Active: all subscriptions in use neither expired nor canceled; The date when the subscription status is calculated/requested precedes the expiration date.
   • Pending activation: The subscription start date begins at a future date.
   • Expired: subscriptions past their renewal date and that were not prolonged by customers, but that are not canceled; The date when the subscription status is calculated/requested comes after the expiration and the grace period deadlines. Customers can no longer make any changes to the subscription. The expiration date of a recurring subscription is calculated based on a 'last day of the month' principle. Let's say for instance that a monthly recurring subscription is starting on January 31st. In February, this subscription will expire on February 28th (or 29th for leap years). In March, the subscription will expire on 31st again.
   • Past due: subscriptions that were not renewed ahead of the expiration deadline for which a grace period was configured. Past due subscriptions still can be renewed at any time by customers while still in the grace period.
   • Canceled: the subscription has been deactivated through the Merchant Control Panel, API, or an operation such as refund or upgrade, thus canceling any future renewals, manual or automatic, and the possibility of upgrading. Customers can no longer make any changes to the subscription.
   • Paused: all automatic charges are suspended for a predefined time period. When subscribers request to pause a subscription, this remains active until the end of the current billing cycle, at which point the subscription will move into a paused status.
3. Expiration date. You can search for subscriptions that either expired, are going to expire in the day you run the search or in the future.
   
   • Anytime: select to have the report display all subscriptions including lifetime/evergreen items.
   • Never: select to have the report display only lifetime subscriptions.
4. Subscription type. This filter allows you to select all subscriptions, the trials offered to customers, subscriptions that resulted from the successful conversion of trials, or all of the above.
5. Subscription channel. The subscription channel is designed to let you filter only eStore subscriptions or those sold through your partners or affiliates (if any).
6. Subscription renewal.
   
   • Auto-recurring: subscriptions for which the auto-renewal process is enabled. Note: subscriptions with the manual renewal option enabled that were switched to auto-renewal will be displayed when the Auto- recurring filter is checked.
   • Manual payment: subscriptions which customers can renew manually. Note: subscriptions for which the auto-renewal process was switched off and transformed to manual renewal will be displayed when the Manual payment filter is checked.
   • Non-recurring: evergreen subscription which lacks an expiration date, as well as non-evergreen items for which customers made a one-time payment.

Advanced filters

You can further narrow down the results returned using filters such as:

1. Geographic regions
2. Countries. Select the location of the customer that purchased the subscription. When all countries are selected the search results returned will not include subscriptions sold to partners for which customer registration is lacking.
3. Partner
4. Customer registration
5. Purchase date. Enables you to filter results according to the date when the subscription was generated by the 2Checkout system.
6. Renewal date. Returns all subscriptions that were renewed during the time interval selected for the filter.
7. Upgrade date. Return all subscriptions that were upgraded during the time interval selected for the filter.
8. Customer/partner notification date.  Filters subscriptions for which notifications were sent during the time interval selected.

Maximum number of results

The subscription search displays a maximum of 1,000 results.

When exporting, a maximum of 100,000 items can be included in a single CSV (comma separated values) file. If you'd like more results beyond the first 100,000 to be exported, simply modify date settings to export results in batches of 100,000.

Time zone support

Customer search supports time zone selection, enabling you to choose either the default 2Checkout time zone (GMT + 02:00) or a custom time zone that you control via Account settings/Edit system settings.

The timezone selected in the Subscription search area controls the timestamps in which data on specific subscription details pages is reported.

The 2Checkout system calculates the status of subscriptions dynamically based on their expiration date, grace period deadline, and the date when the subscription information is requested (when info is displayed in the Control Panel or when a relevant API method is invoked). Only Canceled subscriptions are marked as disabled in the 2Checkout system

Overview

Use the login method for the authentication process in the 2Checkout system.

Parameters

Response

Request

<?php

/**
 * @throws JsonException
 */
function callRPC($Request, $host) {
    $curl = curl_init($host);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 1);
    curl_setopt($curl, CURLOPT_VERBOSE, true);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
    curl_setopt($curl, CURLOPT_SSLVERSION, 0);
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json', 'Accept: application/json'));
    $RequestString = json_encode($Request, JSON_THROW_ON_ERROR);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $RequestString);

    $ResponseString = curl_exec($curl);

    if (!empty($ResponseString)) {
        echo($ResponseString);
        $Response = json_decode($ResponseString, false, 512, JSON_THROW_ON_ERROR);
        if (isset($Response->result)) {
            return $Response->result;
        }
        if (!is_null($Response->error)) {
            echo("Method: {$Request->method}" . PHP_EOL);
            echo("Error: {$Request->error}" . PHP_EOL);
        }
    } else {
        return null;
    }
    return null;
}

$host = 'https://api.avangate.com/rpc/5.0/';

$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

$string = strlen($merchantCode) . $merchantCode . strlen(gmdate('Y-m-d H:i:s')) . gmdate('Y-m-d H:i:s');
$algo = "sha256";
$hash = hash_hmac($algo, $string, $key);

$i = 1;

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'login';
$jsonRpcRequest->params = array($merchantCode, gmdate('Y-m-d H:i:s'), $hash, $algo);
$jsonRpcRequest->id = $i++;

try {
    $sessionID = callRPC($jsonRpcRequest, $host);
    echo("Auth token: {$sessionID}" . PHP_EOL);
} catch (JsonException $e) {
    echo("Error: {$e->getMessage()}" . PHP_EOL);
}

Overview

Use the performAction method via JSON-RPC APIv6 to execute an action on the proposal.

Request parameters

Request sample

<?php

require ('PATH_TO_AUTH');

$proposalId = "0573e71d-38bb-4d61-88ca-b3c557517c68";

$actionPayload = new stdClass();
$actionPayload->ExpirationDate = "2021-01-05T17:21:42+00:00";
$actionPayload->UserId = "john.doe@email.com";
$actionPayload->action = "decline";
$actionPayload->StatusComment = "The price is too high for the first product";
$actionPayload->SentBy = new stdClass();
$actionPayload->SentBy->FirstName = "John";
$actionPayload->SentBy->LastName = "Doe";
$actionPayload->SentBy->Email = "john.doe@email.com";

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

try {
    $result = callRPC($jsonRpcRequest, $host);
    echo "Proposal: </br>", 
    var_dump($result);
}
catch (SoapFault $e) {
    echo "Could not fetch proposal: " . $e->getMessage();
    exit;
}

Response

The performAction call via JSON-RPC APIv6 returns the Proposal object.

Overview

Use this object via SOAP API 6.0 to create new orders and collect payments from shoppers using catalog products defined in your Merchant Control Panel.

For orders that require physical delivery, if no shipping methods are provided, 2Checkout will add to the cart your account's default shipping configuration.

You can find a list of common errors that may arise when using the placeOrder call via API 6.0 here.

Supported payment methods/flows

1. Credit/Debit cards: Visa, Visa Electron, MasterCard, Maestro, Amex, Discover, Dankort, Carte Bleue, JCB. 2Checkout supports local Brazilian cards.
2. PayPal and PayPal Express
3. Purchase Order
4. Wire
5. Check
6. WeChat Pay
7. iDEAL
8. Alipay
9. UnionPay
10. Trustly
11. TEST orders
12. Free orders (no payment information required)
13. Previous order references - In addition to the payment methods enumerated above, 2Checkout also supports 1-click purchase flows in which you use valid previous order references belonging to returning customers to pay for new orders with their previously used cards and PayPal accounts.
14. 2Pay.js

Requirements

For credit card orders placed using 2Checkout API 6.0 or a more recent version, you need to pass through additional parameters that support the 3D Secure flow. 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.

Send the following parameters in the placeOrder call, as part of the PaymentDetails object:

Response

Parameters