Overview

To reduce checkout load time, you can preload the InLine Checkout in the background on page load or when the customer selects a product.

Use case

1. Add an HTML link or button to your page like the one below.
2. Create a JavaScript click handler to execute the InLine Client desired methods.
3. Use the TwoCoInlineCart.products.add({code, quantity, options}) method to prepare your products.
4. Use the TwoCoInlineCart.cart.preload() method to load the cart in the background.
5. Use the TwoCoInlineCart.cart.reloadCart() method to show the cart on your page.

Sample request

HTML

<a href="#" class="btn btn-success" id="buy-button">Buy now!</a>

Javascript

window.addEventListener("load", (event) => {
  TwoCoInlineCart.products.add({
    code: "2CO3MONTHS",
    qty: 1
  });
  TwoCoInlineCart.cart.preload();
});
window.document.getElementById('buy-button').addEventListener('click', function() {
  TwoCoInlineCart.cart.reloadCart();
});

Demo (Using Test Mode)

Overview

Place a manual renewal order using the inline checkout.

Use case

1. Add an HTML link or button in your page like the one below.
2. Create a JavaScript click handler to execute the Inline Client desired methods.
3. Use the TwoCoInlineCart.products.add({code, quantity, options}) method to prepare your catalog product.
4. Set the license code as the subscription reference on the cart TwoCoInlineCart.cart.setSubscription('IMKNNVEY13').
5. Set the customer's email address on the cart (the email must match the subscription) TwoCoInlineCart.billing.setEmail('john.doe@company.com').
6. Set the renewal flag on the cart TwoCoInlineCart.cart.setRenewalFlag(true).
7. Use the TwoCoInlineCart.cart.checkout() method to show the cart on your page.

Sample request

HTML

<a href="#" class="btn btn-success" id="buy-button">Buy now!</a>

Javascript

window.document.getElementById('buy-button').addEventListener('click', function() {
  TwoCoInlineCart.products.add({
    code: "74B8E17CC0"
  });
  TwoCoInlineCart.cart.setSubscription('IMKNNVEY13');
  TwoCoInlineCart.billing.setEmail('john.doe@company.com');
  TwoCoInlineCart.cart.setRenewalFlag(true);
  TwoCoInlineCart.cart.checkout();
});

Demo (Using Test Mode)

Overview

If you are not displaying the card form on page load, you can preload the iframe in the background to speed up the loading time when you mount the componet.

Use case

1. Create a form with id="payment-form":

<form type="post" id="payment-form">
 <div class="form-group">
   <label for="name" class="label control-label">Name</label>
   <input type="text" id="name" class="field form-control">
 </div>
 <button class="btn btn-primary" type="submit">Generate token</button>
</form>

2. Inside the form add an element with id="card-element". The form should now look like this:

<form type="post" id="payment-form">
 <div class="form-group">
   <label for="name" class="label control-label">Name</label>
   <input type="text" id="name" class="field form-control">
 </div>
 <div id="card-element">
   <!-- A TCO IFRAME will be inserted here. -->
 </div>
 <button class="btn btn-primary" type="submit">Generate token</button>
</form>

3. Include the 2Pay.js drop-in payment client JavaScript:

<script type="text/javascript" src="https://2pay-js.2checkout.com/v1/2pay.js"></script>

4. Insert the following configuration JavaScript to preload the iframe in the background on page load.

window.component = null;
window.addEventListener('load', function() {
 // Initialize the JS Payments SDK client.
 let jsPaymentClient = new  TwoPayClient('YOUR_MERCHANT_CODE');
 
 // Create the component that will hold the card fields.
 let component = jsPaymentClient.components.create('card');
 
 // Preload the card fields component in the desired HTML tag. This is where the iframe will be located.
 component.preload('#card-element');
});

5. Display or hide the card form when you are ready

function show() {
   component.mount('#card-element');
}
function hide() {
   component.hide();
}

Demo

After performing the steps above, your implementation should look like this:

Overview

Use the cancelRefund method to issue a total refund for an order processed by 2Checkout.

Requested parameters

This method allows you to cancel a refund initiated from the cPanel or to decline a refund initiated by the shopper from myAccount.

The status of the refund needs to be PENDING or APPROVED.

The refund can be cancelled in up to 2 hours from the initiation. 

Request sample 

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'AVANGATE';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/soap/6.0';
    public const ACTION = 'cancelRefund';
    public const ADDITIONAL_OPTIONS = null;
    public const ORDER_REF = '73152889';
    //array or JSON
    public const PAYLOAD = null;

}

class Client
{
    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?object {
        if (is_array($payload)) {
            $payload = json_encode($payload);
        }
        if (!empty($payload)) {
            // SoapClient works with objects(StdClass)
            $payload = json_decode($payload);
        }
        $soapClient = $this->getClient($url);
        $sessionId = $this->getSession($soapClient);
        $args = array_filter([$sessionId, Configuration::ORDER_REF, $payload]);

        return $soapClient->$action(...$args);
    }

    public function getClient(string $url): SoapClient
    {
        return new SoapClient(
            $url . '?wsdl',
            [
                'location'   => $url,
                'cache_wsdl' => WSDL_CACHE_NONE,
            ]
        );
    }

    public function getSession(SoapClient $client)
    {
        $date = gmdate('Y-m-d H:i:s');
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $string = strlen($merchantCode) . $merchantCode . strlen($date) . $date;
        $algo = 'sha256';
        $hash = hash_hmac($algo, $string, $key);
        $client->__setCookie('XDEBUG_SESSION', 'PHPSTORM');

        return $client->login($merchantCode, $date, $hash, $algo);
    }
}

try {
    $client = new Client();
    var_dump($client->call());
} catch (Exception $ex) {
    var_dump($ex);
}

Response

Overview

Use the cancelRefund method to issue a total refund for an order processed by 2Checkout.

Requested parameters

This method allows you to cancel a refund initiated from the cPanel or to decline a refund initiated by the shopper from myAccount.

The status of the refund needs to be PENDING or APPROVED.

The refund can be cancelled in up to 2 hours from the initiation. 

Request sample

<?php

declare(strict_types=1);

class Configuration
{
    public const MERCHANT_CODE = 'AVANGATE';
    public const MERCHANT_KEY = 'SECRET_KEY';
    public const URL = 'https://api.2checkout.com/rpc/6.0';
    public const ACTION = 'cancelRefund';
    public const ADDITIONAL_OPTIONS = null;
    public const ORDER_REF = '73152889';
    //array or JSON
    public const PAYLOAD = null;
}

class Client
{
    private const LOGIN_METHOD = 'login';
    private $calls = 1;
    private $sessionId;

    private function generateAuth(): array
    {
        $merchantCode = Configuration::MERCHANT_CODE;
        $key = Configuration::MERCHANT_KEY;
        $date = gmdate('Y-m-d H:i:s');
        $string = strlen($merchantCode) . $merchantCode . strlen($date) . $date;
        $hash = hash_hmac('md5', $string, $key);

        return compact('merchantCode', 'date', 'hash');
    }

    public function login(string $url)
    {
        $payload = $this->generateAuth();
        $response = $this->call($url, array_values($payload), self::LOGIN_METHOD);
        $this->sessionId = $response['result'];
    }

    public function call(
        string $url = Configuration::URL,
        $payload = Configuration::PAYLOAD,
        string $action = Configuration::ACTION
    ): ?array {
        if (empty($this->sessionId) && $action !== self::LOGIN_METHOD) {
            $this->login($url);
        }

        if (is_string($payload)) {
            $payload = json_decode($payload, true);
        }
        if (!empty($this->sessionId)) {
            $payload = [$this->sessionId, Configuration::ORDER_REF, $payload];
        }
        $payload = array_filter($payload);

        $request = json_encode([
            'jsonrpc' => '2.0',
            'method'  => $action,
            'params'  => $payload,
            'id'      => $this->calls++,
        ]);

        $curl = curl_init($url);
        curl_setopt($curl, CURLOPT_POST, 1);
        curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
        curl_setopt($curl, CURLOPT_SSLVERSION, 0);
        curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt(
            $curl,
            CURLOPT_HTTPHEADER,
            ['Content-Type: application/json', 'Accept: application/json', 'Cookie: XDEBUG_SESSION=PHPSTORM']
        );
        curl_setopt($curl, CURLOPT_POSTFIELDS, $request);
        $response = curl_exec($curl);
        if (empty($response)) {
            die('Server unavailable');
        }
        echo $response . '</br>';

        return json_decode($response, true);;
    }
}

$client = new Client();
$result = $client->call();
var_dump($result);

Response

Use the 2Checkout Channel Manager API 2.1 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 2.1

Overview

2Checkout Snowflake Data Share gives you direct, SQL-based access to your real-time transactional, subscription, and customer data from the 2Checkout platform. 

Availability

It's available exclusively for organizations with their own Snowflake instance. 

2Checkout Data Share with Snowflake is available on request starting January 2025. Contact our Sales team to request integration with Snowflake. 

Benefits

• Faster, more flexible reporting - generate reports more easily and efficiently compared to out-of-the-box tools
• Higher accuracy & richer datasets - access to detailed, near real-time transactional data allows for more granular insights
• Seamless integration with your BI stack - use Snowflake data alongside other tools and sources to build comprehensive business views 

Snowflake datasets

Subscriptions events

• Purpose: These fields can be used for calculating subscription-specific metrics, such as renewal and disable rates. 

• Key Information:

  • The dataset stores events (meaning that there will be more than 1 entry for the same LICENSE_CODE)

  • The row containing the most recent event (EVENT_DATE) for a subscription (LICENCE_CODE) reflects its last state.

  • Contains: license code, purchase date, expiration date, order reference number, etc.

• Available fields:

Customer events

• Purpose: Analyze customer-specific metrics such as CLV (Customer Lifetime Value).

• Key Information:

  • This dataset stores events (meaning that there will be more than 1 entry for the same customer).

  • The row containing the most recent event (EVENT_DATE) for a customer (CUSTOMER_ID) reflects its last state.

  • Contains: customer ID,  demographics (email, name), lifetime value, etc.

• Available fields:

Orders events

• Purpose: Use this dataset to calculate average order value, refund amounts, or chargebacks.
• Key Information:
  • This dataset stores events (meaning that there will be more than 1 entry for the same order).
  • Contains: order reference number, refunds, chargebacks, taxes associated with the whole order, commissions, etc.
• Available fields:

Subscription orders events

• Purpose: Use this table for product/license prices, discounts, and taxes, or to reach out to customers to ask them to update payment details

• Key Information:

  • This dataset stores events (meaning that there will be more than 1 entry for the same order). 

  • If there are more products in one order, then more rows are associated with the same REFNO.

  • Contains: order reference number, product IDs, customer data, payment type, card expiration date

• Available fields:

Exchange rate events

• Purpose: Allows conversion from one currency to another based on historical rates.
• Key Information:
  • Each row contains exchange rates from one currency to another for each day starting on 2002/09/05
• Available fields:

Overview

PayPal Credit is an open end (revolving), reusable line of credit that when approved, will automatically be added to the shopper’s PayPal account.

With PayPal Credit, the shopper can enjoy the flexibility to pay overtime for everyday purchases. PayPal Credit can be used just about anywhere PayPal is accepted online. PayPal Credit is subject to credit approval and is issued by Synchrony Bank.

How to apply for PayPal Credit

When a shopper applies for PayPal Credit, they’ll be asked to provide the date of birth, net income after taxes, the last 4 digits of the Social Security number and agree to the Terms and Conditions. The shopper will be provided any required disclosures in electronic form. The shopper will know within seconds if they are approved. If approved, the PayPal Credit payment instrument will automatically appear in the PayPal account where the shopper can start to use it right away.

PayPal Credit is subject to credit approval and is offered by Synchrony Bank. 

Availability

PayPal Credit is currently available for US residents who are of legal age in their state of residence.

Supported currencies: USD

Supporting recurring payments: Yes

Benefits

• Increased conversion rates - buy now, pay later (BNPL) options like PayPal Credit reduce friction at checkout by allowing customers to defer payments.
• Higher average order value (AOV) - Customers using PayPal Credit often spend more per transaction, boosting AOV.
• Immediate payment to vendors as they are paid upfront and in full by PayPal, while PayPal handles customer financing and collections. No additional risk or delay in funds settlement for the merchant.

Activate PayPal Credit

Steps to activate PayPal Credit in Control Panel:

1. Navigate to Dashboard.
2. Go to Setup.
3. Click on Ordering options.
4. Click on Payment methods.
5. Activate PP Credit from the list.

Shopper flow

1. The shopper initiates an online purchase.
2. Once the products for purchase are selected, the 2Checkout checkout page will be displayed.
3. The shopper selects PayPal Credit as a payment method and continues the checkout process.
   
4. On the confirmation page, the shopper clicks on the PayPal Credit button.
   
5. The shopper logs into it’s PayPal account.
   
6. Shopper selects PayPal Credit as the payment option.
   
   • If the shopper has not yet applied for PayPal Credit, they will follow an application process.
   • If the shopper has already applied for PayPal Credit, they place the order by clicking the Continue to Review Order button.
7. Once all steps are completed, the Finish page is displayed, as the order is confirmed.
   

<?php 

$url = "https://secure.2checkout.com/paypal-credit.php?merchantCode=MERCHANT_CODE&totalAmount=100&country=US"; 
$ch = curl_init(); 
curl_setopt($ch, CURLOPT_URL, $url); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); 
$response = curl_exec($ch); 
if (curl_errno($ch)) { 
    echo "cURL Error: " . curl_error($ch); 
} else { 
    echo "Response:\n" . $response; 
} 
curl_close($ch); 
 
?>