Overview

Retrieve information about a subscription.

Parameters

Overview

Renew a subscription and collect recurring revenue using the 2Checkout Subscription Reference. You can renew subscriptions for both catalog and dynamic products. 

Requirements

To place a renewal order, you need to provide a valid subscription reference number.

Payment methods

You can place renewal orders using the following payment methods:

• Credit/Debit cards: Visa, Visa Electron, MasterCard, Maestro, Amex, Discover, Dankort, Carte Bleue, JCB. 2Checkout supports local Brazilian cards.
• PayPal and PayPal Express
• Purchase Order
• Wire
• Check
• WeChat Pay
• iDEAL
• Alipay
• Trustly
• TEST orders
• Free orders (no payment information required)
• 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.
• Order with installments
• ApplePay
• 2Pay.js
• Boleto/Pix
• Google Pay

Use the PaymentDetails object to change the payment method used in the ordering process.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$Order = new stdClass();
$Order->Currency = 'USD';
$Order->Language = "EN";
$Order->Country = 'US';
$Order->CustomerIP = '91.220.121.21';
$Order->Source = "sourceAPI.net";
$Order->LocalTime = date('Y-m-d H:i:s');
$Order->Items = array();

/**/
$Order->Items[0]->RenewalInformation = new stdClass();
$Order->Items[0]->RenewalInformation->SubscriptionReference = 'A8C5671BFE'; //subscription used in the renewal process
$Order->Items[0]->Price = new stdClass();
$Order->Items[0]->Price->Type = 'CUSTOM';
$Order->Items[0]->Price->Amount = '10';
$Order->Items[0]->PriceOptions = array('uniqscale1=4');//

$Order->MachineId = "MachineID";

$Order->BillingDetails = new stdClass();
$Order->BillingDetails->Address1 = 'Bil1ing address';
$Order->BillingDetails->Address2 = 'Billing address 2';
$Order->BillingDetails->City = 'Billing City';
$Order->BillingDetails->State = 'Billing State';
$Order->BillingDetails->CountryCode = 'US';
$Order->BillingDetails->Phone = 1231232123;
$Order->BillingDetails->Email = 'customer_details@test.com';
$Order->BillingDetails->FirstName = 'First';
$Order->BillingDetails->LastName = 'Customer';
$Order->BillingDetails->Company = 'Billing Company';
$Order->BillingDetails->Zip = '55104';

$Order->DeliveryDetails = new stdClass();
$Order->DeliveryDetails->Address1 = 'Bil1ing address';
$Order->DeliveryDetails->Address2 = 'Billing address 2';
$Order->DeliveryDetails->City = 'Billing City';
$Order->DeliveryDetails->State = 'Billing State';
$Order->DeliveryDetails->CountryCode = 'US';
$Order->DeliveryDetails->Phone = '12345';
$Order->DeliveryDetails->Email = 'customer_details@test.com';
$Order->DeliveryDetails->FirstName = 'First';
$Order->DeliveryDetails->LastName = 'Customer';
$Order->DeliveryDetails->Zip = "55104";

$Order->PaymentDetails = new stdClass();
$Order->PaymentDetails->Type = "CC";
$Order->PaymentDetails->Currency = $currency;

$Order->PaymentDetails->PaymentMethod = new stdClass();
/**/
$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 Doe";
$Order->PaymentDetails->PaymentMethod->RecurringEnabled = TRUE;
$Order->PaymentDetails->PaymentMethod->HolderNameTime = 1;
$Order->PaymentDetails->PaymentMethod->CardNumberTime = 1;
/**/


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

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

var_dump ($placeOrder);

Overview

Use this object to add/create and update/edit pricing configurations for your account. You can assign one or multiple price option groups to pricing configurations.

You identify a pricing configuration using its unique identifier: Code.

Parameters

Overview

You are now able to customize the payment experience of your customers by adding your own vision to the display of the shopping cart pages. The new ConvertPlus Cart Editor module gives you control over shopping cart elements, by providing an easy-to-use visual interface for your customizations. Cart Editor allows you to define new styles for texts displayed in the shopping cart, add new designs for buttons, select new colors for different cart elements, and many others.

Related links

Availability

Cart Editor is available on all accounts that have ConvertPlus enabled. Contact 2Checkout for more details on ConvertPlus activation.

Cart themes

You can edit the following themes using ConvertPlus Cart Editor. Make a copy of the theme you want to edit, and add your own style and vision to the future shopping cart pages.

One column with payment buttons

This template can be used by all companies looking to increase their conversion rates by using a smart display of the billing and payment information fields in the cart. The short form helps you increase conversion rates, as only mandatory billing fields are displayed. Billing details and card information are presented in one column, making the payment experience smoother for your shoppers.

The display order of the payment methods in the cart reflects their popularity based on the selected billing country.

The input of card information is easier and clearer as the cart auto-detects the card type after typing the first digits of the card. The theme has a responsive design on devices such as desktop, tablet, and smartphone.

ConvertPlus default

The ConvertPlus default template is designed to help you increase conversion rates by embedding the industry’s best practices. Billing details and card information are displayed inline, offering customers a fast and secure checkout. To improve the payment experience for your shoppers, the cart contains a short billing form, having only the mandatory fields displayed.

Shopper’s country/state is detected and pre-filled based on geo-location. The input of card information is easier and clearer as the cart auto-detects the card type after typing the first digits of the card. The display order of the payment methods in the cart reflects their popularity based on the selected billing country.

We're building and adding new features continually, check out the full list of supported functionalities and the current limitations.

Edit a cart theme

Follow the steps below to edit and publish a customized theme:

1. Log in to the 2Checkout Merchant Control Panel.
2. Go to Setup -> Interface templates.
3. Click on ConvertPlus located right near the Default flows tab.
4. Select the theme you want to edit and click Make a copy.
5. Once redirected in the editing visual interface, use the menu from the left side to customize the theme selected. You can apply general customizations on the cart template by changing the properties of different elements, such as links, buttons, panels, messages, logos from the Branding drop-down list. You can also edit specific sections of the cart by using the Cart items, Billing details, Payment details, and Footer drop-down sections.
6. Rename your customized theme by clicking on the current theme title and by adding a new text in the edit box. Save the changes by clicking on the save icon.
7. You can preview and apply any customization made to the cart by using the Preview and Apply buttons from the menu.
8. From the drop-down list located in the top right corner, you can change the page you are customizing (checkout or landing page/retry page/finish page). Add consistency to your work by editing all the pages.
9. Check how your customized theme would look on different devices, by switching between the different device icons displayed in the top right corner.
10. After you apply the changes, click on Save changes to save your customization.
11. Click Close to return to the Interface templates page, or Publish, to make your customization available for creating links in the Generate Links area.

General customizations

ConvertPlus Cart Editor allows you to customize different elements of the shopping cart pages, leading to a personalized payment experience for your shoppers. You can apply general styling to your cart pages by editing the following elements:

• Body - Personalize the properties from the page body by adding your own styling to the font and colors used. Go to Branding > Body to make the desired changes on body attributes.
• Logo - You can easily add your own logo to the shopping cart page, while also reserving the option of hiding the logo image. Click on Branding > Logo drop-down list to control the display of your logo.
• Fields - You have advanced control over the fields display, with the ability to customize the field properties such as background color, border type, label and input colors. You can also control the display of the error messages that might be triggered on cart fields, by adding style to error background/border and label. Click on Branding > Fields to customize your fields.
• Links - You can personalize the display of the links from your shopping cart pages. Select a new color, or choose a different text-decoration for the cart links from Branding > Links.
• Panels - Customize the display of the shopping cart panels from Branding > Panels. You have total control over the text properties, while also being able to make advanced customizations on the padding, color and border attributes of your panels.
• Buttons -  You can change how buttons are displayed in the cart from Branding > Buttons. You have access to a variety of properties for buttons customization, such as: setting default/primary/success colors, adding new border types or setting new text properties.
• Messages - Change the font properties of the messages displayed in the shopping cart pages, both success and error-related, from Branding > Messages.
• Trust logo - Select a display type for the trust logo shown in the cart page by clicking on Branding > Trust logo.

Advanced customizations

In case you want to apply advanced customizations to a cart theme, you can add a different styling to each shopping cart section. ConvertPlus Cart Editor allows you to customize each segment of the cart in a different way, as part of your goal of giving customers a personalized payment experience.

Advanced customizations have priority over the changes made from the Branding menu. For instance, if you edit the color of the links from the Branding menu to red, all the links from the page you are editing will be red. However, by setting the link color from the Cart items section to blue, you are overwriting the customization for this section, and the links color from the Cart items segment will be blue.

Cart Items

Add a different styling to the cart items section from the shopping cart page, by clicking on the Cart items drop-down list. Customize the display of product title, image, quantity and price in the cart by editing the properties of these elements. You are able to add a detailed styling to the coupon box by clicking on Promotion, and you can do advanced customizations to the Delete button, Cart total, and Taxes elements.

Billing details

You can customize the second section of the checkout page by clicking on the Billing details drop-down list. Add your own design to the text properties, background color and border types that compose the environment into which shoppers enter their billing information.

Payment details

You can apply different styling to the payment details section by editing the properties from the Payment details drop-down list. Add a different design to this section by customizing properties such as border type, background color, font size and type to give shoppers a unique experience when they are adding their payment information.

Footer

Click on the Footer drop-down list to start customizing the footer element. You can apply different styling to properties such as border, text and background color.

Overview

Use the searchSku method to perform product SKU search calls with the below parameters.

Request Parameters

Request Example

<?php

require ('PATH_TO_AUTH');

$inputSchema = new \stdClass();
$inputSchema->ProductCode= '6B3CB17DDA_COPY1';

$pricingConfiguration = new \stdClass();
$pricingConfiguration->Code = 'E684EC99B0';

$currency = new \stdClass();
$currency->Code = 'EUR';
$pricingConfiguration->Currencies = [$currency];

$purchaseType = new \stdClass();
$purchaseType->Code = 'RENEWAL';
$pricingConfiguration->PurchaseTypes = [$purchaseType];

$quantityIntervals = new \stdClass();
$quantityIntervals->MinQuantity= 1;
$quantityIntervals->MaxQuantity= 10;
$pricingConfiguration->QuantityIntervals = [$quantityIntervals];

$pagination = new \stdClass();
$pagination->Page = 1;
$pagination->Limit = 10;

$inputSchema->PricingConfigurations = [$pricingConfiguration];
$inputSchema->Pagination = $pagination;


try {
    $skuData = $client->searchSku($sessionID, $inputSchema);
} catch (SoapFault $e) {
    echo "searchSku: " . $e->getMessage();
    exit;
}

var_dump("searchSku", $skuData);

Response Parameters

Response Example

object(stdClass)#22 (2) {
    public $Items" =>
    object(stdClass)#21 (1) {
      public $6B3CB17DDA_COPY1 =>
      object(stdClass)#4 (2) {
        public $ProductCode =>
        string(18) "6B3CB17DDA_COPY1"
        public $SkuPricingOptions =>
        array(1) {
          [0]=>
          object(stdClass)#5 (3) {
            public $Code =>
            string(10) "E684EC99B0"
            public $Details =>
            array(5) {
              [0]=>
              object(stdClass)#6 (7) {
                public $ProductSKU =>
                string(4) "Product_Test_SKU_008899"
                public $Currency =>
                string(4) "EUR"
                public $FromQty =>
                int(1)
                public $ToQty =>
                int(10)
                public $PurchaseType =>
                string(11) "RENEWAL"
                public $Groups =>
                array(1) {
                  [0]=>
                  object(stdClass)#7 (2) {
                    public $GroupCode =>
                    string(7) "GRUP_2"
                    public $Options =>
                    array(1) {
                      [0]=>
                      object(stdClass)#8 (2) {
                        public $Name =>
                        string(7) "grup 2"
                        public $Value =>
                        string(4) "option_code_4"
                      }
                    }
                  }
                }
                public $Options =>
                string(32) "a:1:{i:16885;a:1:{i:0;i:78164;}}"
              }
              [1]=>
              object(stdClass)#9 (7) {
                public $ProductSKU =>
                string(4) "Product_Test_SKU_008902"
                public $Currency =>
                string(4) "EUR"
                public $FromQty =>
                int(1)
                public $ToQty =>
                int(10)
                public $PurchaseType =>
                string(11) "RENEWAL"
                public $Groups =>
                array(1) {
                  [0]=>
                  object(stdClass)#10 (2) {
                    public $GroupCode =>
                    string(7) "GRUP_2"
                    public $Options =>
                    array(1) {
                      [0]=>
                      object(stdClass)#11 (2) {
                        public $Name =>
                        string(6) "grup 2"
                        public $Value =>
                        string(13) "option_code_4"
                      }
                    }
                  }
                }
                public $Options =>
                string(6) "a:0:{}"
              }
            public $Errors =>
            array(0) {
            }
          }
        }
      }
    }
    public $Pagination =>
    object(stdClass)#23 (3) {
      public $Limit =>
      int(10)
      public $Page =>
      int(1)
      public $Count =>
      int(5)
    }

Learn how to import and export product and pricing data using CSV and XML files right from the Merchant Control Panel.

Overview

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

Retrieve next renewal price

Next renewal price object

Overview

A type of payment that the bank makes by accessing funds from an account when the holder instructs it to do so. Money can be drawn either at the time of sale but also when a bill is due, and the transactions can be preauthorized, which is why Direct Debit is also referred to as pre-authorized debit (PAD) or pre-authorized payment (PAP).

Approximately 20% of online payments in Germany in 2010 were made using ELV (Direct Debit), with the number decreasing from 33% in 2009. ELV's share of online transactions has continued to decrease, and is now at under 10% in Germany. 24% of non-cash transactions in Europe in 2010 involved Direct Debit.

Introduction

SEPA stands for Single Euro Payment Area, a European regulatory initiative that creates a standard format for processing transactions in 33 markets across Europe. SEPA Direct Debit blur the lines between cross-border and domestic payments.

Compliance requirements

• The deadline for the migration was February 1st, 2014 - extended until  August 1st.
• The deadline for non-EU countries was February 1st 2016.

Countries impacted by SEPA

SEPA covers the existing 28 EU member states of the European Union, together with Iceland, Lichtenstein, Monaco, Norway and Switzerland):

Austria, Belgium, Bulgaria, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Latvia, Liechtenstein, Lithuania, Luxembourg, Malta, Monaco, Netherlands, Norway, Poland, Portugal, Romania, Slovakia, Slovenia, Spain, Sweden, Switzerland, United Kingdom.

Countries covered by 2Checkout

Germany, the Netherlands, Spain, Belgium, France and Austria for Direct Debit.

Impact at 2Checkout

• Direct Debit, and iDeal
• Local wire transfers you receive from 2Checkout if you're company is headquartered in a market covered by SEPA.

IBAN and BIC

IBAN (International Bank Account Number) and BIC (Business Identifier Code) need to be used exclusively as account and bank identifiers for SEPA transactions. Pre-SEPA they were required only for cross-border payments and moving forward they will also apply to domestic payments.

• 2Checkout will require IBAN and BIC information from shoppers paying with Direct Debit from Germany, the Netherlands, Spain, Belgium, France and Austria (instead of national sort codes and account number).
• 2Checkout will provide IBAN and BIC details for its own account and bank to shoppers using wire transfers.
• 2Checkout will pay vendors using IBAN and BIC info for their accounts and banks.
• 2Checkout will update bank and account information for existing customers/subscribers, using the data for automatic subscription renewal charges.

Mandates and E-mandates

Shoppers authorize 2Checkout to collect a payments and instruct the their bank to pay those collections with SEPA mandates.

• 2Checkout uses e-mandates and does not require shoppers to fill in and submit paperwork.
• Mandates expire within 36 months after the last initiated collection.
• 2Checkout stores mandates at least for 14 months after the last collection of funds.

Process changes

Workflow

1. Shoppers in the Netherlands, Germany, Spain, Belgium, France and Austria select Direct Debit as their preferred payment method.
2. One the next page, they need to fill in their bank account information.

3. They'll be redirected to the Thank You page when the purchase is finalized.

Cart design changes

IBAN and SWIFT code will be collected during the purchase process.

Emails

Emails already communicate the due dates and billing amounts to customers (renewal notifications), along with 2Checkout's IBAN and SWIFT code (for follow-ups).

F.A.Q.

1. What type of payments does SEPA govern?
   
   • Both single (one-off) and recurring Direct Debit collections. There's no limit on amounts transferred.
2. What currency is used for money transfers?
   
   • While existing local currencies can still be used in the purchase process by consumers, money transfers will be done exclusively in Euro.
3. What are the rules for refunds?
   
   • Payers can ask for a "no-questions-asked" refund right during the eight weeks (56 days) following the debiting of a payer's account. This period is extended to 13 months for unauthorized Direct Debit collections.

Overview

Use the updatePromotionCoupon method to add single or multiple coupons to a promotion.

Updating a promotion with multiple coupons causes any existing single coupon to be removed.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

// Promotion code corresponding to the promotion you want to add coupons to
$promotionCode = '';

// 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'];

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

Overview

Use the searchAffiliates method to find out details about one or more affiliates.

Request Parameters

Request Example

Response Parameters

Response Example

{  
   "AffiliateCode":"TFTF76455ee4YFCFCT6545465",
   "Status":"Active",
   "Affiliate Name":"Affiliate 1",
   "Website":"https://affiliate1.com",
   "CommissionLists":[  
      {  
         "ListName":"CommissionList1",
         "CommissionRate":"25%"
      }
   ],
   "RequestDate":"2018-10-05",
   "Categories":["PC security","Mobile security","Tablet security"],
   "NotifyUpdates":true,
   "TCStatus":"Accepted",
   "AffiliateContact":{  
      "FirstName":"FN",
      "LastName":"LN",
      "Phone":"0040723483987",
      "Email":"FN.LN@2AFFLT.COM",
      "Country":"Spain"
   }
},
{  
   "AffiliateCode":"TFTF76455ee4YFCFCT6545466",
   "Status":"Active",
   "Affiliate Name":"Affiliate2",
   "Website":"https://Affiliate2.com",
   "CommissionLists":[  
      {  
         "ListName":"CommissionList1",
         "CommissionRate":"25%"
      }
   ],
   "RequestDate":"2018-10-05",
   "Categories":["PC security","Mobile security","Tablet security"],
   "NotifyUpdates":true,
   "TCStatus":"Agreed",
   "AffiliateContact":{  
      "FirstName":"FN",
      "LastName":"LN",
      "Phone":"0040723483987",
      "Email":"FN.LN@2AFFLT.COM",
      "Country":"Spain"
   }
}