Overview

If you enable the Requires delivery confirmation option for 2Checkout delivery, the order processing is put on hold until you manually confirm the delivery of the order. 

For orders you fulfill using your own platform or resources (Fulfillment made by you), you need to confirm the delivery of all the products in the orders, to finalize the payment process. Only after you provide fulfillment confirmation will 2Checkout mark orders as completed and update their status to Finished. Fulfillment confirmations can be accomplished either manually or automatically, depending on the fulfillment type and automation level that you implement.

Confirm fulfillment

Confirm fulfillment for each order having the "In progress" status:

• Select the order(s) in the Fulfillment Confirmations section by ticking the corresponding boxes.
• Click Confirm fulfillment.
• You can also send an automatic delivery confirmation, IDN, to 2Checkout in the form of an HTTP POST.

Please note that only after receiving the fulfillment confirmation for the order, 2Checkout can execute the money transfer from the customer's account.

FAQ

1. Are there any restrictions on the characters that can be used in the Static Lists?
   
   • Only printable characters can be used in the static list.
2. What is the format for a static list file?
   
   • Each line in the static list will be considered as one code to be delivered. The newline character can have any style: Windows, Mac or Linux.
3. Can a subscription key/code be presented to the user as two lines by embedding a new line character in the key text? 
   
   • No, embedding a new line character in the key text will make it part of the code to be sent to the customer, thus breaking the desired output. To deliver codes on multiple lines, dynamic lists should be used instead, where more than one line of codes can be sent using the XML schema.

Overview

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

Retrieve subscription history

Subscription history object

Overview

Use the updateProduct method to update the configuration of a subscription plan/product you already configured for your account.

Parameters

When updating a subscription plan/product, you also update its PricingConfigurations. However, you cannot modify:

• The pricing configuration CODE.
• The PricingSchema from DYNAMIC to FLAT or vice versa.

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 = 'NewSubscriptionPlan_Code_12345';

try {
    $ProdbyCode = $client->getProductByCode($sessionID, $ProductCode);
}

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

var_dump("ProductInfo", $ProdbyCode);

$ProdbyCode->ProductName = 'NewSubscriptionPlan_Name_2.0';

try {
    $NewSubscriptionPlan = $client->updateProduct($sessionID, $ProdbyCode);
}

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

var_dump("UpdatedProductInfo", $NewSubscriptionPlan);

?>

Overview

Use the searchProducts method to extract information about the subscription plan/products you configured for your account.

Pagination

Use pagination to decrease the request loading time, while better handling the returning responses.

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.

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

Parameters

Request

<?php

require ('PATH_TO_AUTH');

$SearchOptions = new stdClass();
$SearchOptions->Name = '2Checkout Subscription'; //Product name
$SearchOptions->Types = array ('REGULAR', 'BUNDLE'); //product type (standalone), regular or bundle
$SearchOptions->Enabled = True;
//$SearchOptions->GroupName = '';
$SearchOptions->Limit = '10';
$SearchOptions->Page = '10';

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

?>

Response

Overview

2Checkout automatically sends out the Follow-up unfinished Instant payment methods email as part of the overall strategy to increase the conversion rate for new purchases. Shoppers receive unfinished payment follow-up messages if they place orders, but 2Checkout cannot successfully complete transactions and collect funds. This notification makes it easy for customers to return to the shopping cart and finalize a purchase without having to go back through the ordering process.

Availability

The lead management set of tools is available for 2Monetize accounts (merchants on the Reseller business model).

Follow-up emails

2Checkout sends out follow-up messages for unfinished payments made using one of the following payment methods:

1. Instant payment methods (Visa/MasterCard/Eurocard, American Express, Diners Club, JCB, PayPal, Discover/Novus, Chinese Debit Card, 支付宝 (Alipay), iDEAL).
2. Online direct debit.

Failed transactions can happen because of various reasons, such as expired cards, insufficient funds, authorization declined, etc.

You can add follow-ups, up to a maximum of 15 notification emails.

Email content

The email includes:

1. Link to the shopping cart for the retry.
2. Alternative payment methods to finalize the purchase.
3. Order, product, and subscription details.

Sample emails

Preview and test the 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 Follow-up unfinished Instant payment methods email under the Follow-Up section.

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

The redesigned template for this email has automatically replaced default templates.

If your preview of the follow-up notification 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

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

Retrieve upgrade options

Subscription upgrade object

Overview

Get information about an existing order.

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

$refNo = 'YOUR_ORDER_REFERENCE'

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

Errors

Overview

Extend the lifetime of a subscription in the Avangate system on-demand. Use the extendSubscription method to set a new expiration deadline for a subscription.

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;
}
$SubscriptionReferenceTest = '48F5AC7011';
$days = 7;
try {
    $extendedSubscription = $client->extendSubscription($sessionID, $SubscriptionReferenceTest, $days);
}
catch (SoapFault $e) {
    echo "extendedSubscription: " . $e->getMessage();
    exit;
}
var_dump("extendedSubscription", $extendedSubscription);

Overview

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

  Retrieve an additional field                               Retrieve assigned additional fields                              Retrieve all additional fields    

Additional fields object