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"
   }
}

Overview

Use the deleteSku method to remove product SKU codes through an API call using the below parameters.

Request Parameters

Request Example

<?php

require ('PATH_TO_AUTH');

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

$pricingConfiguration = new \stdClass();
$pricingConfiguration->PriceConfigurationCode = 'E684EC99B0';
$pricingConfiguration->SKUs = ['Product_Test_SKU_001050', 'Product_Test_SKU_001053'];

$product->PriceConfigurations = [$pricingConfiguration];


try {
    $skuOutput = $client->deleteSku($sessionID, [$product]);
} catch (SoapFault $e) {
    echo "deleteSku: " . $e->getMessage();
    exit;
}

var_dump("deleteSku", $skuOutput);

Response Parameters

Response Example

array(1) {
  [0] =>
  class stdClass#5 (4) {
    public $ProductCode =>
    string(16) "6B3CB17DDA_COPY1"
    public $PriceConfigurations =>
    array(1) {
      [0] =>
      class stdClass#6 (3) {
        public $PriceConfigurationCode =>
        string(10) "E684EC99B0"
        public $SKUs =>
        array(2) {
          [0] =>
          string(23) "Product_Test_SKU_001050"
          [1] =>
          string(23) "Product_Test_SKU_001053"
        }
        public $Errors =>
        array(0) {
        }
      }
    }
    public $SKUs =>
    array(0) {
    }
    public $Errors =>
    array(0) {
    }
  }
}

Overview

2Checkout tailors the way in which shoppers see prices in their local currencies according to the conventions in their country.

• Using the currency symbol instead of the ISO code - ensures that cart/checkout prices are as friendly as possible for local shoppers.
• Positioning the currency symbol - Placing symbols according to conventions in each market, either before or after the price.
• Decimal and thousands of separators - Once more, local conventions dictate whether a dot or a comma should be used to separate decimals and thousand.

*Up to 99 billing currencies are available depending on your region.

Available billing currencies

Available currencies by account type

Currency Exchange Rate

You can instantly query the currency exchange rates used in the 2Checkout shopping carts by accessing:

https://secure.2checkout.com/content/exchange-xml.php?CURRENCY=USD

The currency exchange rate is updated daily, at 00:00 (2Checkout Time Zone GMT+2) with the exception of weekends and legal holidays.

The query will return an XML schema holding the corresponding values for the other currencies compared to the one supplied in the CURRENCY parameter.

Overview

Use the deletePromotionCoupon method to remove multiple coupons from a promotion. You cannot delete a single coupon. The coupon is required for the promotion.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

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

// 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' => 'deletePromotionCoupon',
'params' => array($sessionID, $promotionCode, $promotionCoupon)
);
var_dump (callRPC($jsonRpcRequest, $host));

Overview

Add a custom HTML formatted text to the last stage of the ordering process (the Thank You page - finish.php), engaging shoppers directly after payment confirmation (transaction was authorized successfully). Insert special variables including first and last name, email, order reference, total value and currency using the buttons above the custom AfterSale Message field.

Use the Tracking Script area to include external scripts (such as Google Analytics) for an advanced feedback monitoring of sales, cart visitors and tracking of customer conversion rates.

Availability

1. AfterSale messages for the desktop version of the shopping cart are available for all 2Checkout accounts.
2. Setting AfterSale messages for mobile users requires an account with the 2Checkout shopping cart activated. Contact 2Checkout directly for more details.

What is the AfterSale message?

You can use this feature to reach out to shoppers who successfully placed an order with personalized messaging.

When is the AfterSale message displayed to shoppers?

The AfterSale Message is displayed to customers only after they successfully place an order.

• Payment needs to be authorized successfully. This usually happens for online payment methods that are authorized instantaneously, such as credit/debit cards and PayPal.
• Payment needs to go through without any problems or errors.

How do AfterSale Messages work?

1. Go to Dashboard →Setup → Ordering Options →​​​​​​​ AfterSale Message.
2. Select the type of platform you want the message to be displayed for. AfterSale Messages need to be defined for each platform separately:
   
   • Desktop
   • Mobile
3. Use the Special Variables buttons to insert custom variables identifying the shopper placing the order, such as first and last name, email address, order reference number, total value, currency. Below is an example of an AfterSale Message.
4. You can use HTML formatting and tags and edit the code directly. You also have the option of previewing your message using the Preview button.
5. Select the language for your message. Use the Apply for all languages option to set the same message for all languages available for your account. Customers using a language for which you did not set an AfterSale message will not be offered the special messaging.
6. To edit AfterSale Messages, you need to edit each item individually. Selecting the Apply for all languages option will overwrite all existing messages with the latest text you supply.
7. Click Save message.

AfterSale Message example

Dear Mr./Mrs. <--{FIRST_NAME}--> <--{LAST_NAME}-->,
<p>Thank you for choosing our services! </p>
<p>Your order reference number is <--{REFNO}--> with a total amount of
<--{TOTAL}--> <--{CURRENCY}-->.
Your e-mail address used for this order is <--{EMAIL}--> </p>

Display the AfterSale message for all orders

By default, the after-sale message is displayed only for orders with payments authorized instantly (this includes usually credit cards and PayPal), after the payment is complete (transaction needs to be authorized successfully). To display the message for all placed orders regardless of the payment status:

1. Go to Dashboard →​​​​​​​Setup →​​​​​​​ Ordering Options.
2. Scroll down to the bottom of the Order settings area and check the checkbox for the Show message for all placed orders option.
3. Click Save Settings.

The message will be displayed even for orders where the payment is not yet received (like bank transfers or checks).

FAQ

Is there a way to bypass the Thank You page and not display the AfterSale Message?

Yes. If you use a Redirect URL when generating buy-links, i.e. including the BACK_REF parameter in buy-links together with a specific URL where shoppers are redirected after placing the order. Shoppers will be redirected to this URL after the payment is confirmed. The redirect URL replaces the default 'Thank you' page (except for offline payment methods such as Bank Transfer).