Use the 2Checkout Channel Manager API to manage partner and reseller orders.

Availability 

The partner API methods are available only in tandem with the Channel Manager module.

Requirements 

Contact 2Checkout to start using the Channel manager API.

Overview

2Checkout added a new product attribute in the Merchant Control Panel, the Product Tax Category, to increase the accuracy of the tax determination and reporting process.

Availability

Available by default for all 2Checkout merchants. Read here how to apply the Product Tax category from your Merchant Control Panel.

Product Tax Category rules

Taxes differ according to the various product tax categories. Tax deduction takes into account the product tax category added at product level for more accurate tax determination (for example, there are certain states  in USA where SaaS products are charged an 8% sales tax, others where the sales tax is 0%).

Default Tax category assignment

• For the 2Monetize accounts: Products that don't have a tax category assigned will be automatically considered as "Electronically-delivered software".
• For 2Sell & 2Subscribe accounts: Products that don't have a tax category assigned will be automatically considered as “Physical Goods”.

For all new products, the selection of the Product Tax category is mandatory.

1. Use the following URL: https://api.avangate.com/channel-manager/2.1/soap/
2. Authenticate using the login method and create a session (connection).
3. Set partner
4. Throughout the lifetime of the session (max 10 minutes), you can invoke all 2Checkout API methods. To invoke methods you need to send a request to 2Checkout. Read more on the request object below.
5. The 2Checkout system provides responses to all requests. Read more on the response object below. 

Overview

After signing up for an account by filling in the form on the 2Checkout website, you will be able to access the Merchant Control Panel.

Before you can start selling with 2Checkout, you need to finalize a few more steps.

The steps below apply to all accounts, including those using third-party services to connect to the 2Checkout platform. 

Customer journey

1. Add your first product or plan

To be able to use your 2Checkout account to sell your goods and services, you need to request the activation of your live account. In order to do this, you must first:

1. Add a product/plan
2. Generate a buy-link and place a test order

Product catalog management is one of the most important aspects of your online store. This guide will show you how to add the first product within your 2Checkout Merchant Control Panel. Our platform supports the creation of both electronic and physical products. Adding shipping methods will give you more control over your costs and income from tangible products.

You can add your products one by one, or do a batch import via XML files. 

You can also receive payments from customers worldwide without the need of adding catalog products. ConvertPlus enables you to pass the product information dynamically to the checkout page, either by using URL parameters or via your 2Checkout Merchant Control Panel.

2. Generate your first buy-link and place a test order

Link your website to the 2Checkout ordering process

2Checkout offers different options for linking your website to your secure hosted 2Checkout order flows. The ConvertPlus buy-links trigger different order flows designed to suit a variety of business needs.

To see the different options available, go to Setup → Generate links. To link your website to your 2Checkout ordering page, copy and paste the checkout links you’ve generated into the web page that will host the purchase button/link.

If you’re aiming to integrate other shopping cart applications with your 2Checkout account and take advantage of an integrated solution in order to provide a superior buying experience and receive worldwide payments, you can check the available options here. Integrations with other shopping cart applications are available only for 2Checkout accounts that handle their own tax and invoice management. 

Place Test Orders

No matter what option you choose when setting up your products or subscription plans, or integrating the checkout process within your website, it is important to run tests to make sure the selected settings work flawlessly. Testing is the best way to make sure that the actual user experience is the one you want. It is also a way to test how 2Checkout notifies you about the different types of transactions.

Using the 2Checkout testing system you can replicate new acquisitions and trial purchase scenarios, as well as automatic renewals, trial conversions, manual renewals, and upgrades.

To generate a test link and place a test order using the test billing information, click here.

3. Request the activation of your live account

When you log into your account (until your application is approved), you will see a blue banner at the top of your account that says, “Your account is currently in demo mode”. Even though your account is in demo mode, everything is completely functional. You can set up products, renewals, and fulfillment or delivery information, as well as test and use all the other available features. This mode allows you to test your setup to make sure everything works as expected, prior to launching your 2Checkout store.

To finalize your account setup, so that your 2Checkout live transactions can be processed, you must submit your application for approval, as explained here.

The 2Checkout's underwriting team will review your application right away and will get in touch with you to either request additional information, if required, or notify you about the resolution.

Once your application is approved, your 2Checkout account is live and you can start using it to process real orders. Your Dashboard will continue to display sample data until you register your first real transaction.

Discover the 2Checkout platform

These are the main areas you'll navigate to set up your account, run your business, get support, and more:

• Merchant Control Panel: The 2Checkout Merchant Control Panel helps you manage your store and all your day-to-day operations, from customizing your checkout experience to updating product information and reviewing orders and customers.
• Knowledge Center: Find how-to articles, videos, guides, and troubleshooting resources. You can also find expert guidance and best practices on how to increase conversion and retention rates while expanding your business globally.
• Support: 2Checkout has dedicated teams that can help you with your financial, technical, or order-related questions via email or Live Chat. Check here the full list of teams that are ready to provide support to your inquiries.
• 2Checkout Customer myAccount: Your customers will be automatically registered into 2Checkout myAccount when they first place an order on your website. They can use 2Checkout myAccount to view their order status and evolution, products or subscription details and history, as well as change their personal customer information, or request a refund.

How to get help

If you are having any difficulty with the three steps above, our support teams can help you.

In the upper-right side of your Control Panel, you’ll find a permanent link to our Knowledge Center.

If you are still having trouble finding the right answers to your questions, the 2Checkout support team is always ready to assist. You can submit tickets or chat with members of the support team regarding your specific questions.

FAQ

1. How do I know if 2Checkout is available in my country?

2Checkout is available in most countries, but there are a number of territories and countries that are restricted from doing business with 2Checkout. If you and/or your business are from one of these countries, you cannot use the 2Checkout products and services.

Also, 2Checkout does not accept PSP merchants or businesses (2Sell and 2Subscribe accounts) from several countries (Afghanistan, Algeria, American Samoa, Antigua and Barbuda, Bahamas, Benin, Botswana, Brunei Darussalam, Cambodia, Cameroon, Cote d'Ivoire, Faroe Islands, French Guiana, Gabon, Georgia, Ghana, Greenland, Guadeloupe, Guinea, Guinea-Bissau, Iraq, Jamaica, Lybia, Maldives, Mali, Mozambique, Myanmar, Namibia, New Caledonia, Nicaragua, Northern Mariana Islands, Qatar, Reunion, Rwanda, Senegal, Seychelles, Eswatini, Tajikistan, Tanzania, United Republic of Timor-Leste, Tunisia, Turkmenistan, Uganda, United States Minor Outlying Islands, Venezuela, Yemen). Shopper transactions from these countries are allowed based on internal risk assessment. 

2. What tax identification documents do I need to create an account?

Read here about all the documents and details you need to provide to 2Checkout to create an account.

3. Can I add a second website to the 2Checkout account to get the same payment information?

If you have a 2Sell or 2Subscribe account, you can have more than 1 associated URL. The request to add a new URL on the account requires risk review and approval, and you can submit it to compliance@2checkout.com.

If you have a 2Monetize account, this is limited to pointing towards 1 URL for the process of generating sales. Any new website that generates traffic needs to have its own account, and all accounts operated by the same entity can be grouped under one multi-account. Requests for new URLs can be sent to csmsupport@2checkout.com or info@2checkout.com.

4. How can I change the website URL or business name in my account?

You cannot perform these updates on your own from your account, but you can reach out to us as additional documentation might be required.

If you have a 2Sell or 2Subscribe account, you can send your request to change the website URL/business name to compliance@2checkout.com, and our Underwriting team will help you out.

If you have a 2Monetize account, you can request the update to our CSM team's email addresses: csmsupport@2checkout.com or info@2checkout.com. 

5. Can I create a 2Checkout account as an individual, without a company?

Yes, this option is currently available in the application form for any type of account you may choose to apply for.

6. How can I cancel/delete my 2Checkout account?

If you want to delete your account, contact us from the same email address on which your account is registered and our dedicated teams will help you settle and close your account.

Overview

The fulfillment process depends on the type of options you selected when configuring fulfillment for your products in your Merchant Control Panel.

Availability

Available for all 2Checkout accounts.

Fulfillment/delivery

Static lists

2Checkout handles fulfillment on your behalf using Static lists. 2Checkout does not provide links to actual product download files or valid activation keys for test orders, even if you configured/uploaded them into the platform. Instead, testers receive this default activation key: ___TEST___CODE___.In addition, testers receive a dummy file for download, test_file.zip, and not the actual product file.

Dynamic lists

You deal with fulfillment using Dynamic lists and need to confirm the completion of the process through IDN or in the Fulfillment Confirmations area. In scenarios in which you generate activation codes/binary keys using a key generator that you host in your system, 2Checkout strongly recommends that you adapt it to deliver test keys/codes. 2Checkout does not provide links to actual product download files for test orders, even if you configured/uploaded them into the platform. Testers receive a dummy file for download, dubbed test_file.zip, and not the actual product file.

2Checkout sends a collection of parameters to your server within HTTP POST to the URL that generates the code/key. The TESTORDER parameter will help you differentiate between test and 'real' orders. Use this parameter to restrict code/key delivery only for 'real' orders. Note: Unless you prepare your system accordingly, you will deliver valid codes/keys for test orders.

Read the guidance provided in the 2Checkout delivery (fulfillment) article to understand what kind of information is supplied by 2Checkout to your system using HTTP POST.

Fulfillment confirmation is automatic and does not require confirmation. Note: 2Checkout does not deliver files or keys in this scenario.

IDN (Instant Delivery Notification)

If your setup requires fulfillment confirmation through IDN, then you also need to confirm fulfillment for test orders in order for their status to advance to Finished.

IRN (Instant Refund Notification)

You can use IRN to issue refunds for the test orders you placed.

ISE (Instant Search Order Export)

You can control the inclusion or exclusion of test order data in ISE file output by using the EXPORT_TEST_ORDERS parameter:

Email notifications

1. The 2Checkout system will send out payment receipts and fulfillment/delivery notifications for test orders, per your account's configuration.
2. Provided that you set up manual and automatic renewal notifications, the 2Checkout system will deliver the renewal emails for test subscriptions according to your account's configuration.

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.2checkout.com/rpc/6.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

The object includes information related to the upsell campaigns, including product information and discount settings.

UpSell Object

The object below is returned as a successful response for the following SOAP API 6.0 methods:

• Create an upsell campaign

Overview

Set the IPN and LCN settings in your Merchant Control Panel and assign a single specific webhook to a single URL by using the NOTIFICATION_URL parameter. If you add a second, third, or fourth endpoint in the IPN or LCN tab, 2Checkout can send Instant Payment Notifications (IPN) and License Change Notifications (LCN) to alternative URLs, not just the defaults.

Availability

Available for all 2Checkout accounts using the Default Flows cart. Not available to 2Checkout accounts using only the ConvertPlus shopping cart. 

How it works

The 2Checkout system sends out notifications (IPNs and LCNs) to the URLs that you can configure in the URL areas under:

1. IPN settings (https://secure.2checkout.com/cpanel/ipn_settings.php)
2. LCN settings (https://secure.2checkout.com/cpanel/lcn_settings.php)
3. Both IPN and LCN (https://secure.2checkout.com/cpanel/webhooks_api.php)

You can prioritize sending to a specific endpoint URL using the NOTIFICATION_URL parameter, as described below under the 'How do I get 2Checkout to send IPNs and LCNs to URLs other than the default links set?' section. However, if you set a default URL in the Notification URLs section, then the notification is sent to that particular URL, as well as any other URL set in the IPN/LCN dedicated tab unless specified otherwise when using the parameter.

Requirements

Enter valid URLs for both IPN and LCN when editing URL configurations.

Default IPN and LCN URLs 

IPN

1. Navigate to IPN settings (https://secure.2checkout.com/cpanel/ipn_settings.php).
2. Enter the default URL where the 2Checkout system will send out Instant Payment Notifications (IPNs). 
3. Changes to the IPN URL in the IPN settings area reflect under the default URL notification configuration for your account, if only one value is entered and edited. For multiple values, only the first one is taken into account.

LCN

1. Navigate to LCN settings (https://secure.2checkout.com/cpanel/lcn_settings.php).
2. Enter the default URL where the 2Checkout system will send out License Change Notifications (LCNs).
3. Changes to the LCN URL in the LCN settings area reflect under the default URL notification configuration for your account, if only one value is entered and edited. For multiple values, only the first one is taken into account.

Default URL configuration 

1. Navigate to the Integrations → Webhooks and API section (https://secure.2checkout.com/cpanel/webhooks_api.php).
2. Edit the Default URL configuration.
3. Enter URLs for both IPN (mandatory) and LCN notifications (mandatory) and Save.
4. The settings automatically reflect under the IPN URL in the IPN settings area and the LCN URL in the LCN settings area. Note that this will not edit the current value, but add one new entry. Removing this value from a total of 4 in the dedicated IPN/LCN section will not replace the default one in the general section, it will only leave a blank.
5. Changes to the default URL notification configuration for your account reflect under the IPN URL in the IPN settings area and the LCN URL in the LCN settings area.
6. Click Reset to revert a URL configuration to the last saved state.

Custom IPN and LCN URLs 

1. Navigate to the Integrations → Webhooks and API section (https://secure.2checkout.com/cpanel/webhooks_api.php) in your Merchant Control Panel.
2. Scroll down to the Notification URLs section and click on the Add additional URL button to gain access to the parameter value field.
3. Enter a parameter value. You will use this parameter in buy-links for new purchases, manual subscription renewals, and upgrades, controlling the URLs used by the 2Checkout system to send IPN and LCN notifications. Read below for instructions.
4. Enter URLs for both IPN (mandatory) and LCN notifications (mandatory) and click Save.
5. The settings reflect under the IPN URL in the IPN settings area and the LCN URL in the LCN settings area.
6. Changes to the default URL notification configuration for your account reflect under the IPN URL in the IPN settings area and the LCN URL in the LCN settings area.
7. Click Reset to revert a URL configuration to the last saved state.

How do I get 2Checkout to send IPNs and LCNs to URLs other than the default links set?

You can use the multiple URL functionality and send IPN and LCN notifications to several URLs. Once you set multiple URLs for receiving IPN or LCN notifications, you will receive the same keys/parameters on all endpoints without having the possibility to customize them based on the defined endpoints. However, if the URL from the general section is not declared under the IPN/LCN tabs as well, the notification will still be sent if the parameter is used. You can set up eight (8) URLs for both your IPN and LCN notifications.

To set multiple URLs, you need to use the:

• Parameter value specified for each new URL configuration. The parameter value can be found in the Parameter Value field by navigating to Integrations → Webhooks and API section, scrolling down to the Notification URLs section, selecting the Configuration parameter, and clicking on the Edit button.

• And the NOTIFICATION_URL parameter in buy-links (for new purchases, manual subscription renewals, and upgrades).

For example, let's assume that you created a URL configuration with the following settings:

And that you're using this buy-link:

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

You need to insert NOTIFICATION_URL=MYTESTNOTIFICATIONS into the buy-link:

https://secure.2checkout.com/order/checkout.php?PRODS=1234567&QTY=1&CART=1&CARD=2&NOTIFICATION_URL=MYTESTNOTIFICATIONS

IPN and LCN HASH 

Default URLs for IPN and LCN

IPN HASH = HMAC_SHA signature calculated from IPN_PID[0], IPN_PNAME[0], IPN_DATE and DATE and the Secret key for your account for notifications sent to the default URL parameters configured for your account.

LCN HASH = HMAC_SHA signature calculated using the secret key for your account and the values received for LICENSE_CODE, EXPIRATION_DATE, DATE and the Secret key for your account for notifications sent to the default URL parameters configured for your account.

Custom IPN and LCN configurations

IPN HASH = HMAC_SHA signature calculated from IPN_PID[0], IPN_PNAME[0], IPN_DATE and DATE and the system-generated secret keys when custom URL configurations are used.

LCN HASH = HMAC_SHA signature calculated using the values received for LICENSE_CODE, EXPIRATION_DATE, DATE and the system-generated secret keys when custom URL configurations are used.

FAQs

1. Where can I find the secret key?

For custom IPN and LCN URL:

1. Navigate to the Integrations → Webhooks and API section (https://secure.2checkout.com/cpanel/webhooks_api.php).

2. Click on the Add IPN URL or on the Add LCN URL buttons, or the Edit button of one of the existing URL configurations.

3. The system-generated secret key valid for each URL configuration respectively is available in the IPN/LCN secret key field.

2. What notifications are sent to the URLs set through the NOTIFICATION_URL parameter and for what triggers?

The IPN and LCN notifications for the initial purchase, as well as for the subsequent renewals of the subscriptions generated for this order and for any future upgrades will be sent to the IPN and URL parameters

3. What is the default value of NOTIFICATION_URL?

Include NOTIFICATION_URL=DEFAULT (case sensitive) to send IPN and LCN notifications to the default URLs you configure.

4. Is the value of the parameter saved on each order and subscription?

The IPN value is mentioned in the order history, but at the subscription level, neither the IPN nor the LCN is visible, unless you use the subscription reference number in the reporting section to identify the LCN.

5. What happens with future notifications if I used the NOTIFICATION_URL parameter?

All future LCN and IPN notifications for future renewals and upgrades of current subscriptions for which a NOTIFICATION_URL value was used will be sent to the URLs configured for that value.

6. What happens if I change the value for a parameter used?

All future LCN and IPN notifications for renewals and upgrades of current subscriptions for which a NOTIFICATION_URL value was used will be sent to the default URLs configured for your account. What happens if I change the custom URLs for a configuration?

All future LCN and IPN notifications for renewals and upgrades of current subscriptions for which a NOTIFICATION_URL value was used will be sent to the new URLs configured.

7. Can I use multiple endpoints for the NOTIFICATION_URL parameter and send IPNs and LCNs to more than one URL each?

You can use multiple endpoints in the specific LCN/IPN section, but you cannot add multiple endpoints in the general section. The NOTIFICATION_URL parameter offers the option to use specific endpoints for specific buy-links, but does not “add” to the default ones. You can set up eight (8) URLs for both your IPN and LCN notifications.

8. Is this parameter available for network cross-selling orders through the 2Checkout system?

No, the parameter will only work for your account.

9. Does this parameter work for partner and API orders?

This functionality is not supported for the time being.