| Verifone Developer Portal

Import product data using XML files

Overview

2Checkout recommends that you use XML when importing product and pricing data into the system.

Availability

Importing XML files is available for all 2Checkout accounts.

Requirements

It's recommended that at least one product be configured in the 2Checkout system. This way you'll be able to download the offerings as an XML and access a schema that best fits your specific account.

Product

Use the Product object to create/add, update/edit, and retrieve subscription plans/products for your account. You can control:

Product information
Pricing
Subscription plan settings and renewal configuration
Subscription plan recurring billing
Fulfillment
Shipping classes
Localization

Import limitations

For optimal performance, we recommend importing batches of 20 to 30 products at once, and using XML files smaller than 750 MB.

At this point in time, the Import from URL functionality is not available for XML files.

Mandatory elements

Below is an example of the minimum required data for the importing process when using XML files:

<?xml version="1.0" encoding="UTF-8"?>
<Import>
<Products>
<Product enabled="1">
<ProductName><![CDATA[Product for import]]></ProductName>
<ProductCode><![CDATA[productforimportCODE12345]]></ProductCode>
<PricingConfigurations>
<PricingConfiguration default="1"><DefaultCurrency>EUR</DefaultCurrency></PricingConfiguration>
</PricingConfigurations>
</Product>
</Products>
</Import>

Product

<Product id="1234567" enabled="1"> - product is enabled

<Product id="1234567" > - product is disabled

<Product id="1234567" enabled="0"> - product is disabled

Product code (mandatory )	Product ID (optional)	Result
Existent	Missing	Product is updated
Existent	Existent	Product is updated
Existent	New (is ignored)	Product is updated
New	New (is ignored)	New product is added
New	Missing	New product is added
New	Existent	New product is added

Product code

Make sure to set unique product codes to identify your products in the 2Checkout system. In scenarios involving product import and export, the product code takes precedence over the product ID, which can be excluded altogether. While the system-generated ID is unique across the platform, the product code that you control needs to be unique only for standalone accounts. This enables you to perform such tasks as product migration from one 2Checkout account to another.

Pricing configuration

To import a product with the minimum required information, the Pricing configuration element must be included, along with the default currency. All other elements can be omitted.

How do I import an XML file?

To import existing product data from the 2Checkout platform:

Make your way to Products under Setup.
Click on Import.
Click Choose file and select the XML stored on your machine.
Hit Next step.
The 2Checkout system validates the XML file.
Click Start upload.

Parameters

Additional fields

Parameters	Type/Description
AdditionalField	Object
Label	String
	Field text.
Code	String
	Field identifier. Alpha-numeric chars, underscores and dashes.
Type	String
	Field type: LISTBOX CHECKBOX TEXTBOX HIDDEN
ApplyTo	Sting
	ORDER PRODUCT
Values	Array of values
	Custom values you control.
ValidationRule	String
	The validation rule restricting the type of information shoppers can enter in the additional field during the purchase process.
Translations	Array of objects
	Details below.
Translation	Object
Label	String
	Field text translated in the language of the Translations object.
Values	Object
	Custom values you control translated in the language of the Translations object.
Language	String
	ISO language code. (ISO 639-1 two-letter code).

Pricing

Parameter				Type/Description
PriceOptionsGroup				Object
Name				String
				Price option group name. Use this parameter when adding a new price options group. To edit the name of a price option group use the Name parameter under the Translations object.
Description				String
				Pricing option group description.
Translations				Array of objects
				Details below.
	Name			String
				Product pricing options group name, localized under Options.
	Description			String
				Product pricing options group description, localized under Options.
	Language			String
				ISO language code. (ISO 639-1 two-letter code).
Code				String
				Unique code that The Avangate system generates or set for each pricing options group.
Type				String
				The type of the pricing options group. Possible values: · RADIO · CHECKBOX · INTERVAL · COMBO
Options				Array of objects
				Details below.
	Name			String
				Pricing option child name.
	Description			String
				Pricing option child description.
	Translations			Array of objects
				Details above.
		Name		String
				Localized product pricing options group name under PriceOptionGroup. Localized pricing option child name under Options.
		Description		String
				Localized product pricing options group description under PriceOptionGroup. Localized pricing option child description under Options.
		Language		String
				ISO language code. (ISO 639-1 two-letter code).
	Code			String
				The code you set or that the Avangate system generated for each pricing option child inside a pricing options group parent.
	ScaleMin			Int
				The minimum value of a scale interval set for each pricing option child inside a pricing options group parent of the type INTERVAL.
	ScaleMax			Int
				The maximum value of a scale interval set for each pricing option child inside a pricing options group parent of the type INTERVAL.
	SubscriptionImpact			Object
				Details below.
	Months			String
				The value in months the Avangate system adds or subtracts from the initial billing cycle of a subscription.
	Impact			String
				Possible values: · ADD · SUBTRACT · LIFETIME
	PriceImpact			Object
				Details below.
		ImpactOn		String
				Possible values: BASE corresponding to impact on base price GLOBAL for impact on calculated sum.
		Impact		String
				Impact on price per unit: ADD SUBTRACT
		Percent		String
				The value of the percentage out of the price per product unit, when you use PERCENT for Method.
		Method		String
				Possible values: · PERCENT · FIXED
		Amounts		Array of objects.
				Details below.
			Currency	String
				Currency ISO code - ISO 4217.
			Amount	String
				The amount defined for each specific currency active for your account, when you use FIXED for Method.
	Default			Boolean
				TRUE for preselected options. Missing for options that are not preselected.
Required				boolean (0/1)
				True if you made the pricing option group mandatory.

Product

Parameters	Type/Description
Product	Object
AvangateId	Int
	Unique, system-generated Avangate product ID. Read-only.
ProductCode	String
	The product code that you can define for each of your offerings. Needs to be unique.
ProductType	String
	REGULAR or BUNDLE
ProductName	String
	The name of the product
ProductVersion	String
	The product version number
GroupName	String
	The name of the Product Group to which the product belongs. Cannot be edited as part of the addProduct call.
ShippingClass	Object
	Existing shipping class object with the structure detailed below.
	Name	String
		The name of the shipping class
	Amount	Decimal
		The shipping costs
	Currency	String
		The currency ISO code used for shipping costs - ISO 4217.
	ApplyTo	String
		Possible values: • PRODUCT • ORDER
	Type	Possible values: • FIXED • PERCENT
GiftOption	boolean
	True or false depending on whether the product can be gifted or not.
ShortDescription	String
	The product's short description
LongDescription	String
	The product's long description
SystemRequirements	String
	System requirements
ProductCategory	String
	Product category
Platforms	Array of Platform objects
	Array of objects detailing the platforms supported by the application. Details below.
	PlatformName	String
		The label of the platform per the product configuration.
	Category	String
		Platform category per product configuration.
ProductImages	Array of Image objects
	Image object. Details below. Read-only.
	Default	Boolean
		True or False depending on whether you set the image stored at the address in the URL parameter as default or not.
	URL	String
		The location of the image on the Avangate system.
TrialUrl	String (anyURI)
	The URL from where shoppers can download trial software.
TrialDescription	String
	Descriptive text entered for trials.
Enabled	Boolean
	True/false depending on whether the products are active or disabled. When empty, Avangate marks the product as disabled.
AdditionalFields	Array of AdditionalFieldAssigned objects
	Array of existing additional fields assigned to products. Details below.
	Label	String
		The name of the additional field assigned to a product.
	Code	String
		The code of the additional field assigned to a product.
	Enabled	Boolean
		True or false depending on whether the assigned product field is enabled or not.
	Required	Boolean
		True or false depending on whether the assigned product field is required or not.
	URLParameter	String
		The value of the system generated URL parameter for the product field that can be used in Buy Links.
Translations	Array of ProductTranslation objects
	Details below.
	LongDescription	String
		The translated long description in the language corresponding to the Translation object.
	TrialUrl	String
		The trial URL for users speaking the language corresponding to the Translation object.
	TrialDescription	String

	SystemRequirements	String
		Localized system requirements.
	Name	String
		Localized product name.
	Description	String
		Localized product short description.
	Language	String
		ISO 639-1 two-letter code.
PricingConfigurations	Array of PricingConfiguration objects
	Details below. Avangate creates pricing configurations during the process when you add a product.
	Name	String
		Pricing configuration name
	Code	String
		System-generated identifier.
	Default	boolean (0/1)
		True for the default pricing configuration
	BillingCountries	Array of strings
		ISO codes of the countries assigned to the pricing configuration. Empty unless specific countries are assigned to a pricing configuration.
	PricingSchema	String
		DYNAMIC – With a base price FLAT – Without a base price
	PriceType	String
		Possible values: NET / GROSS
	DefaultCurrency	String
		The ISO code of the default currency for the pricing configuration
	Prices	Object
		Details below.
	Regular	Array of objects
		Details below.
	Amount	Int
		The price of the product.
	Currency	String
		ISO code of the currency for the product price.
	MinQuantity	Int
		The minimum quantity of volume discounts. Default is 1.
	MaxQuantity	Int
		The maximum quantity of volume discounts. Default is 99999.
	OptionCodes	Array of objects
		Details below.
	Code	String
		Price option identifier.
	Options	Array of strings
		The pricing options group option code you configured that the Avangate system uses to calculate product prices for pricing configurations without a base price.
	Renewal	Array of objects
		Details below.
	Amount	Int
		The price of the product.
	Currency	String
		ISO code of the currency for the product price.
	MinQuantity	Int
		The minimum quantity of volume discounts. Default is 1.
	MaxQuantity	Int
		The maximum quantity of volume discounts. Default is 99999.
	OptionCodes	Array of PriceOptionCode objects
		Details below.
	Code	String
		Price option identifier.
	Options	Array of strings
		The pricing options group option code you configured that the Avangate system uses to calculate product prices for pricing configurations without a base price.
	PriceOptions	Array of AssignedPriceOptionGroup objects
		Details below.
	Code	String
		System generated pricing options group code (you can also configure it) that the Avangate system uses to calculate product prices for pricing configurations without a base price.
	Required	Boolean
		True or False depending on whether you want to make it mandatory for shoppers to select the price option during the puyrchase process.
BundleProducts	Array of BundleProductCode objects
	Details below.
	ProductId	String
		Unique, system-generated product ID.
	ProductCode	String
		Editable product code that you control.
Fulfillment	String
	BY_AVANGATE NO_DELIVERY – The Avangate system finalizes orders immediately after it receives payment confirmation. BY_VENDOR – you are responsible for delivering/fulfilling orders
Prices	Array of Price objects
	Use this object only when Pricing Configurations are not available for your account. Details below.
	Amount	Int
		The price of the product.
	Currency	String
		ISO code of the currency for the product price.
	MinQuantity	Int
		The minimum quantity of volume discounts. Default is 1.
	MaxQuantity	Int
		The maximum quantity of volume discounts. Default is 99999.
	OptionCodes	Array of objects
		Details below.
	Code	String
		Price option identifier.
	Options	Array of strings
		The pricing options group option code you configured that the Avangate system uses to calculate product prices for pricing configurations without a base price.
GeneratesSubscription	boolean
	TRUE or FALSE depending on whether you set the product to generate subscriptions or not. NULL for bundles for which you set the following subscription management option: “Use the subscription settings of each product in the bundle”
SubscriptionInformation	ProductSubscriptionInformation Object
	Details below. NULL for bundles which you set to use the renewal settings of child products and not of the parent bundle.
	DeprecatedProducts	Array
		Deprecated products.
	BundleRenewalManagement String
		Possible values: GLOBAL INDIVIDUAL Can be NULL.
	BillingCycle	String
		The number of subscription billing cycle units (months or days). Possible values: 0 (zero represents a one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)
	BillingCycleUnits	String
		The units of the billing cycle: M - months D - days
	IsOneTimeFee	Boolean
		True or False depending on whether the subscription is evergreen or not.
	ContractPeriod	Object
		Details below.
	Period	Int
		The contract period in months or days. -1 for unlimited contracts.
	PeriodUnits	String
		The contract period units days \| months
	IsUnlimited	boolean
		This flag is true if the contract is for an unlimited period
	Action	String
		The action performed after the subscription expires. Possible values CANCEL \| RESTART
	EmailsDuringContract Boolean
		True or False depending on whether you suppress renewal notification emails throughout the duration of the contract or not.
	UsageBilling	Int
		The usage billing interval must be smaller than or equal to the grace period. Interval of time within the grace period, when the Avangate system attempts to automatically charge customers for recurring costs and additional metered usage fees (in arrears). Avangate renews subscriptions only after subscribers make all outstanding payments per the renewal settings (from the expiration or the renewal date). If automatic renewal and usage charges fail, subscriptions can be manually renewed only by the end of the grace period, after which they expire. Can be NULL.
	GracePeriod	Object
	Type	String
		CUSTOM – you configured grace period setting at product level. GLOBAL – global grace period settings apply.
	Period	String
		Number of days set for the grace period.
	PeriodUnits	String
		D - Days.
	IsUnlimited	Boolean
		True or False depending on whether you set the grace peri2od to unlimited or not.
	RenewalEmails	Object
		Details below. Can be NULL. Available only in Product API 2.5 and later.
	Type	String
		GLOBAL - Send emails according to the global renewal notification settings. CUSTOM – per product renewal notification settings
	Settings	Object (can be NULL)
		Details below.
	ManualRenewal Object (can be NULL)
		Details below.
	Before30Days Boolean
		True or False.
	Before15Days Boolean
		True or False.
	Before7Days Boolean
		True or False.
	Before1Day	Boolean
		True or False.
	OnExpirationDate Boolean
		True or False.
	After5Days	Boolean
		True or False.
	After15Days	Boolean
		True or False.
	AutomaticRenewal	Object (can be NULL)
		Details below.
	Before30Days Boolean
		True or False.
	Before15Days Boolean
		True or False.
	Before7Days Boolean
		True or False.
	Before1Day	Boolean
		True or False.
	OnExpirationDate	Boolean
		True or False.
	After5Days	Boolean
		True or False.
	After15Days	Boolean
		True or False.
FulfillmentInformation	Object
	Details below. Can be NULL. Available only in Product API 2.5 and later.
	IsStartAfterFulfillment Boolean
		True or False. Depending on whether you want the subscription lifetime to start afther the completion of the fulfillment process or not.
	IsElectronicCode	Boolean
		True or False. Depending on whether you configure the delivery of keys/codes for the product or not.
	IsDownloadLink	Boolean
		True or False. Depending on whether you configure the delivery of a product file or not.
	IsDownloadInsuranceService Boolean
		True or False. Depending on whether you enable the Download Insurance Service or not, for a product for which you configure a product file.
	IsInstantDeliveryThankYouPage Boolean
		True or False. Depending on whether you enable instant delivery in the Thank You page or not.
	IsDisplayInPartnersCPanel Boolean
		True or False. Depending on whether you share access to the product file with your channel partners or not.
	CodeList	Object (can be NULL)
		Details below.
	Code	String
		The unique code list identifier.
	Name	String
		Name of the code list.
	Type	String
		Code list type: STATIC DYNAMIC
	ProductFile	Object (can be NULL)
		Details below.
	Code	String
		Unique product file identifier.
	Name	String
		Display name.
	File	String
		Name of the product file.
	Version	String
		File version.
	Size	String
		File size.
	Type	String
		File type.
	LastUpdate	String
		YYYY-MM-DD HH-MM-SS. Date time stamp when you last updated the file.
	AdditionalInformationByEmail String (can be NULL)
		The text you set up in the Additional fulfillment information - by email area.
	AdditionalInformationEmailTranslations Object (can be NULL)
		Array of localized Additional fulfillment information - by email texts.
	AdditionalThankYouPage String (can be NULL)
		The text you set up in the Additional fulfillment information - "Thank you" page area.
	AdditionalThankYouPageTranslations Array (can be NULL)
		Array of localized Additional fulfillment information - "Thank you" page texts.

Retrieve product by code

Overview

Use getProductByCode to extract product information using the unique identifier you assign to subscription plans/products.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
ProductCode	String
	The product code that you control.

Response

Parameters	Type/Description
Product	Object

Request

<?php

require ('PATH_TO_AUTH');

$ProductCode = "subscr1";

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

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

var_dump("ProductInfo", $ProdbyCode);


?>

Place an order with installments

Overview

Use the placeOrder method to create an order and collect the payment.

Supported payment methods

Credit/Debit cards: Visa and MasterCard local Brazilian cards.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
Order	Required (Object)
	Object designed to collect all data necessary for an order, including billing, product/subscription plan and payment details.

Requirements

Payment methods: Visa, MasterCard or AMEX
Country: Brazil
Currency BRL
Specified number of installments under the PaymentMethod object. (Minimum installment threshold is 5 BRL.)
- Phone number
- Fiscal code (CPF/CNPJ)
Mandatory billing information must include:
Transaction: non-recurring
Installments are available only for:
- Brazilian customers
- Local Visa, MasterCard and AMEX cards
- Non-recurring transactions

<?php

require ('PATH_TO_AUTH');
 
$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'brl';
$Order->Country = 'BR';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->Affiliate = new stdClass();
$Order->Affiliate->AffiliateCode = 'Partner123'
$Order->Affiliate->AffiliateSource = 'MobilePlatform'
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1; 
$Order->Items[0]->PriceOptions = NULL;

$Order->BillingDetails = new stdClass();
$Order->BillingDetails->FirstName = 'FirstName';
$Order->BillingDetails->LastName = 'LastName';
$Order->BillingDetails->CountryCode = 'BR';
$Order->BillingDetails->State = 'DF';
$Order->BillingDetails->City = 'LA';
$Order->BillingDetails->Address1 = 'Address example';
$Order->BillingDetails->Address2 = NULL;
$Order->BillingDetails->Zip = '70403-900';
$Order->BillingDetails->Email = 'customer@email.com';
$Order->BillingDetails->Phone = "556133127400";
$Order->BillingDetails->FiscalCode = "056.027.963-98";
$Order->BillingDetails->Company = NULL;

$Order->DeliveryDetails = NULL;

$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'CC';
$Order->PaymentDetails->Currency = 'brl';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '10.10.10.10';
$Order->PaymentDetails->PaymentMethod->RecurringEnabled = true;
$Order->PaymentDetails->PaymentMethod->CardNumber = "4111111111111111";
$Order->PaymentDetails->PaymentMethod->CardType = 'visa';
$Order->PaymentDetails->PaymentMethod->ExpirationYear = '2019';
$Order->PaymentDetails->PaymentMethod->ExpirationMonth = '12';
$Order->PaymentDetails->PaymentMethod->HolderName = 'John';
$Order->PaymentDetails->PaymentMethod->CCID = '123';


$jsonRpcRequest = array (
'method' => 'getInstallments',
'params' => array($sessionID, $Order),
'id' => $i++,
'jsonrpc' => '2.0'
);
echo '<BR>';
echo 'The content of the current session:';
echo '<BR>';

$installments = callRPC((Object)$jsonRpcRequest, $host, true);
var_dump ($installments);

Add promotion translations

Overview

Use the addPromotionTranslations method via JSON-RPC 4.0 to add localized texts to existing promotions.

Parameters

Parameter		Type/Description
sessionID		Required (string)
		Output of the Login method.
promotionCode		Required (string)
		The code corresponding to the promotion that you want to add translations to.
promotions		Required (array of PromotionTranslations objects)
PromotionTranslations		Object
	language	Required (string)
		ISO country code corresponding to the country you want to set the translation for.
	name	Required (string)
		Localized promotion name applicable to the selected country.

Response

Parameters		Type/Description
promotionTranslation		Object

Request

<?php

function callRPC($Request, $host, $Debug = true) {
    $curl = curl_init($host);
    curl_setopt($curl, CURLOPT_POST, 1);
    curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 0);
    curl_setopt($curl, CURLOPT_VERBOSE, true);
    curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 0);
    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);
    curl_setopt($curl, CURLOPT_POSTFIELDS, $RequestString);
    if ($Debug) {
        $RequestString;
    }
    $ResponseString = curl_exec($curl);
    if ($Debug) {
        $ResponseString;
    }
    if (!empty($ResponseString)) {
        var_dump($ResponseString);
        $Response = json_decode($ResponseString);
        if (isset($Response->result)) {
            return $Response->result;
        }
        if (!is_null($Response->error)) {
            var_dump($Request->method, $Response->error);
        }
    } else {
        return null;
    }
}

$host = 'https://api.avangate.com/rpc/3.1/';

$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

$string = strlen($merchantCode) . $merchantCode . strlen(gmdate('Y-m-d H:i:s')) . gmdate('Y-m-d H:i:s');
$hash = hash_hmac('md5', $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);
$jsonRpcRequest->id = $i++;

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

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

// Defining a translation for German shoppers
$promotionTranslation1 = new stdClass;
$promotionTranslation1->Language = 'de'; 
$promotionTranslation1->Name = 'YOUR_GERMAN_PROMOTION_NAME';

// Defining a translation for Bulgarian shoppers
$promotionTranslation2 = new stdClass;
$promotionTranslation2->Language = 'bg'; 
$promotionTranslation2->Name = 'YOUR_BULGARIAN_PROMOTION_NAME';

$translations = [$promotionTranslation1, $promotionTranslation2];

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

One click (1-click) purchase

Overview

2Checkout supports 1-click purchases for returning customers who paid for their previous orders with:

Credit/Debit cards
PayPal

How does this work?

Identify returning customers.
Access data on the previous purchases of returning customers.
Validate previous order references for 1-click purchase scenarios using the isValidOrderReference method.
Place a new order using a valid previous order reference as the payment method.
2Checkout charges returning customers using their payment-on-file information, either a card or their PayPal account.

Availability

Select 2Checkout accounts. Contact 2Checkout for more details.

Requirements

Use only references of previous orders with one of the following statuses AUTHRECEIVED or COMPLETE.
The email address of the BillingDetails object is mandatory and it needs to match the email address used as a part of the billing details of the initial order whose reference you're now using to place a new order. 2Checkout checks whether the email addresses are identical, and throws an error if they're not, blocking the order placement process. Note: You need to provide only the email address of the shopper, and can ignore the rest of the required customer billing information. If you enter any billing details in addition to the email address, you'll have to provide all information required in the BillingDetails object.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
Order	Required (Object)
	Object designed to collect all data necessary for an order, including billing, product/subscription plan and payment details.

Response

Order information

Object

Request


<?php
echo "<pre>";
$host   = "https://api.2Checkout.com";
$client = new SoapClient($host . "/soap/3.0/?wsdl", array(
    'location' => $host . "/soap/3.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 = "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 = "SECRET_KEY";// your account's secret key available in the 'System settings' area of the cPanel: https://secure.2checkout.com/cpanel/account_settings.php
$now = date('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;
}
$orderReference = '45452071';
try {
    $validOrderRef = $client->isValidOrderReference($sessionID, $orderReference);
}
catch (SoapFault $e) {
    echo "validOrderRef: " . $e->getMessage();
    exit;
}
var_dump("validOrderRef", $validOrderRef);
try {
    $existentOrder = $client->getOrder($sessionID, $orderReference);
}
catch (SoapFault $e) {
    echo "existentOrder: " . $e->getMessage();
    exit;
}
$Order = new stdClass();
$Order->RefNo = NULL;
$Order->Currency = 'usd';
$Order->Country = 'US';
$Order->Language = 'en';
$Order->CustomerIP = '91.220.121.21';
$Order->ExternalReference = NULL;
$Order->Source = NULL;
$Order->AffiliateId = NULL;
$Order->CustomerReference = NULL;
$Order->Items = array();
$Order->Items[0] = new stdClass();
$Order->Items[0]->Code = 'my_subscription_1';
$Order->Items[0]->Quantity = 1; 
$Order->Items[0]->PriceOptions = NULL;
$Order->Items[0]->SKU = NULL;
$Order->Items[0]->Price = NULL;
$Order->Items[0]->CrossSell = NULL;
$Order->Items[0]->Trial = false; 
$Order->Items[0]->AdditionalFields = NULL;
$Order->BillingDetails = new stdClass();
$Order->BillingDetails = $existentOrder->BillingDetails;
$Order->DeliveryDetails = NULL;
$Order->PaymentDetails = new stdClass ();
$Order->PaymentDetails->Type = 'PREVIOUS_ORDER';
$Order->PaymentDetails->Currency = 'usd';
$Order->PaymentDetails->PaymentMethod = new stdClass ();
$Order->PaymentDetails->CustomerIP = '10.10.10.10';
$Order->PaymentDetails->PaymentMethod->RecurringEnabled = true;
$Order->PaymentDetails->PaymentMethod->RefNo = $orderReference;
$Order->Promotions = NULL;
$Order->AdditionalFields = NULL;
$Order->LocalTime = NULL;
$Order->GiftDetails = NULL;
try {
    $newOrderPaidWithPreviousRef = $client->placeOrder($sessionID, $Order);
}
catch (SoapFault $e) {
    echo "newOrderPaidWithPreviousRef: " . $e->getMessage();
    exit;
}
var_dump("newOrderPaidWithPreviousRef", $newOrderPaidWithPreviousRef);
?>

Checkout with expiration using the signature in InLine Cart

Overview

Use the expiration key to define the validity of a buy-link. The expiration needs to be signed before using the checkout in InLine Cart. In case the expiration is overdue, then the signature is considered invalid.

Use case

Add an HTML link or button on your page like the one below.
Create a JavaScript click handler to execute the Inline Client desired methods.
In order to set expiration, use the TwoCoInlineCart.cart.setExpiration(TIMESTAMP) method.
Use the TwoCoInlineCart.products.add({code, quantity, options, price}) method or the TwoCoInlineCart.products.addMany(products) method to prepare your product(s).
Below it is a signature token request payload for this example. A success response contains a JSON with the property “signature“ which needs to be used to the next step to set the signature using the TwoCoInlineCart method.

{
  "merchant": "AVLRNG",
  "currency": "USD",
  "expiration": 2524608000,
  "products": [
    {
      "code": "74B8E17CC0"
    }
  ]
}

In this example we used a timestamp for January 1st, 2050 as an example. The signature obtained is 16ef22d988d356356ee2437d26114370e29e6293fb4f2e8b58cefad31020950d.

6. Use the TwoCoInlineCart.cart.setExpiration(2524608000) method to set the expiration.

7. Use the TwoCoInlineCart.cart.setSignature('16ef22d988d356356ee2437d26114370e29e6293fb4f2e8b58cefad31020950d') method to set the signature. It is important that you employ the TwoCoInlineCart.cart.removeAll() method just before the TwoCoInlineCart.products.addMany(products) or TwoCoInlineCart.products.add(product) to clear the products, as the signature is based on the products' definition, or simply request a new signature.

8. 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 bundle now!</a>

JavaScript

window.document
  .getElementById('buy-button')
  .addEventListener('click', function() {
  TwoCoInlineCart.cart.setExpiration(2524608000);
  TwoCoInlineCart.products.add({
    code: "74B8E17CC0"
  });
  TwoCoInlineCart.cart.setSignature('16ef22d988d356356ee2437d26114370e29e6293fb4f2e8b58cefad31020950d');
  TwoCoInlineCart.cart.checkout();
});

Demo

See the Pen Untitled by Dorian Floarea (@2checkout-documentation) on CodePen.

Update promotion coupon

Overview

Use the updatePromotionCoupon method via SOAP API 4.0 to add single or multiple coupons to a promotion.

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

Parameters

Parameter		Type/Description
sessionID		Required (string)
		Output of the Login method.
promotionCode		Required (string)
		The code corresponding to the promotion that you want to update.
promotionCoupon		Required (object)
	type	Required (string)
		Coupon type. Available values: SINGLE, use in conjunction with Code MULTIPLE, use in conjunction with Codes
	Code/Codes	Required (string / array of strings)
		Coupon code (for SINGLE) or array of coupon codes (for MULTIPLE).

Response

Parameter	Type/Description
promotionCoupon	Object

Request

<?php 

class Client
{
    protected static $merchantCode;
    protected static $loginDate;
    protected static $hash;
    protected static $baseUrl;
    protected static $callCount = 0;
    protected static $sessionId = '';

    protected static $client;

    public static function setCredentials($code, $key)
    {
        static::$merchantCode = $code;
        static::$loginDate = gmdate('Y-m-d H:i:s');
        static::$hash = hash_hmac('md5', strlen($code) . $code . strlen(static::$loginDate) . static::$loginDate, $key);
        static::$sessionId = static::login();
    }

    public static function setBaseUrl($url)
    {
        static::$baseUrl = $url;
    }

    public static function login()
    {
        $client = static::getClient();
        return $client->login(static::$merchantCode, static::$loginDate, static::$hash);
    }

    public static function __callStatic($name, $arguments = array())
    {
        $client = static::getClient();

        array_unshift($arguments, static::$sessionId);
        $response = call_user_func_array(array($client, $name), $arguments);

        return $response;
    }

    protected static function getClient()
    {
        $opts = array(
            'http'=> ['user_agent' => 'PHPSoapClient'],
            'ssl' => [
                'verify_peer' => false,
                'verify_peer_name' => false,
            ],
        );

        if (null === static::$client) {
            static::$client = new \SoapClient(static::$baseUrl . '?wsdl', [
                'location' => static::$baseUrl,
                'cache_wsdl' => WSDL_CACHE_NONE,
                'stream_context' => stream_context_create($opts),
            ]);
        }

        return static::$client;
    }
}

Client::setBaseUrl('https://api.2checkout.com/soap/3.1/');
Client::setCredentials('YOUR_MERCHANT_CODE', 'YOUR_SECRET_KEY');
Client::login();

$promotionCode = 'YOUR_PROMOTION_CODE'; // code of the promotion that you want to update

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

$response = Client::updatePromotionCoupon ($promotionCode,$promotionCoupon); // Update existing coupons
var_dump($response);

Catalog order session content object

Overview

Use this object to retrieve session content and to guide shoppers through advanced payment flows, such as those of PayPal, PayPal Express, Wire, Check, etc.

Attributes

Order session contents
Errors				Optional (StringArray)
				Payment gateway processing errors.
Items				Array of objects
				Details below.
	ProductDetails			Object
				Details below.
		Name		Optional (string)
				Product name.
		ExtraInfo		Optional (string)
				The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.
		RenewalStatus		Optional (boolean)
				true for orders renewing subscriptions. false for all other orders: new purchases, upgrades.
		Subscriptions		Object
				Details below.
			SubscriptionReference	Optional (string)
				Unique, system-generated subscription identifier.
			PurchaseDate	Optional (string)
				The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the Avangate system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-08-11 15:18:52
			SubscriptionStartDate	Optional (string)
				Example: 2015-09-29 17:57:59
			ExpirationDate	Optional (string)
				The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-09-11 15:18:52
			Lifetime	Optional (boolean)
				true – For non-recurring, evergreen subscriptions. false – For recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Trial	Optional (boolean)
				true – For trial subscriptions. false – For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Enabled	Optional (boolean)
				true – For active and past due subscriptions. false – For expired and cancelled subscriptions.
			RecurringEnabled	Optional (boolean)
				true - customers opted for subscriptions to renew automatically when they expire. false - customers did not choose to renew the subscription automatically.
	PriceOptions			Optional (Array of strings)
				Product price options.
	Price			Object
				This object returns the price per unit at order line level. In the case of trials, the object returns the costs for the trial to full subscription conversion.
		UnitNetPrice		Optional (double)
				The value per product unit, excluding sales tax/VAT expressed in the payment currency.
		UnitGrossPrice		Optional (double)
				Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		UnitVAT		Optional (double)
				Sales tax/VAT per product unit expressed in the payment currency.
		UnitDiscount		Optional (double)
				Value of the discount per product unit expressed in the payment currency.
		UnitNetDiscountedPrice		Optional (double)
				The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which Avangate deducts the unit discount.
		UnitGrossDiscountedPrice		Optional (double)
				Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.
		UnitAffiliateCommission		Optional (double)
				Value of the affiliate commission per product unit calculated expressed in the payment currency. Avangate deducts discounts from the costs incurred by shoppers before calculating affiliate commissions. Avangate does not take into account shipping costs when calculating affiliate commissions. NULL when Avangate does not apply an affiliate commission.
		Currency		Optional (string)
				The currency ISO code for the payment - ISO 4217. Example: usd.
		NetPrice		Optional (double)
				The value per order line, excluding sales tax/VAT expressed in the payment currency.
		GrossPrice		Optional (double)
				Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		NetDiscountedPrice		Optional (double)
				The NetPrice value per order line, excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.
		GrossDiscountedPrice		Optional (double)
				Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. Example: UnitNetPrice: 99 UnitGrossPrice: 120.39 UnitVAT: 21.39 UnitDiscount: 9.9 UnitNetDiscountedPrice: 89.1 UnitGrossDiscountedPrice: 110.49 UnitAffiliateCommission: 22.28 Currency: "usd" NetPrice: 198 GrossPrice: 240.77 NetDiscountedPrice: 178.2 GrossDiscountedPrice: 220.97 Discount: 19.8 VAT: 42.77 AffiliateCommission: 44.56
		Discount		Optional (double)
				Value of the discounts per order line expressed in the payment currency.
		VAT		Optional (double)
				Value of sales tax/VAT per order line expressed in the payment currency.
		AffiliateCommission		Optional (double)
				Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.
	Code			Optional (string)
				Unique product identifier your control. Max length 256 characters.
	Quantity			Optional (integer)
				Number of units
	SKU			Optional (string)
				SKU identifier.
	CrossSell			Optional (Object)
				Details below.
		ParentCode		Optional (string)
				The product code of the master product you set to trigger the campaign.
		CampaignCode		Optional (string)
				Unique, system-generated identifier for cross-sell campaigns.
	Trial			Optional (Object)
				Details below.
		Period		Optional (integer)
				The length of the trial subscription lifetime in days.
		GrossPrice		Optional (double)
				Total trial price in the payment currency before Avangate deducts any taxes, discounts, etc.
		VAT		Optional (double)
				The total value of taxes for the trial in the payment currency, before Avangate deducts any discounts.
		NetPrice		Optional (double)
				Total trial price in the payment currency, not including taxes, before Avangate deducts any discounts.
	AdditionalFields			Optional (array of objects)
				Details below.
		Code		Optional (string)
				The alpha-numeric characters, underscores and dashes that are set as the field identifier.
		Text		Optional (string)
				Field text visible to shoppers in the cart.
		Value		Optional (string)
				Selected field value.
	Promotion			Optional (object)
				Details below.
		Name		Optional (string)
				Promotion name.
		Description		Optional (string)
				Promotion description.
		StartDate		Optional (string)
				The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
		EndDate		Optional (string)
				The date when you set the promotion to end. NULL for promotions you want active indefinitely.
		MaximumOrdersNumber		Optional (integer)
				Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
		MaximumQuantity		Optional (integer)
				Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
		InstantDiscount		Optional (boolean)
				The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
		Coupon		Optional (string)
				Promotion coupon/voucher.
		DiscountLabel		Optional (string)
				Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
		Enabled		Optional (string)
				true or false, depending on whether a promotion is active or disabled.
		Type		Optional (string)
				REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
Promotions				Optional (Array of objects)
				Details below.
	Name			Optional (string)
				Promotion name.
	Description			Optional (string)
				Promotion description.
	StartDate			Optional (string)
				The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
	EndDate			Optional (string)
				The date when you set the promotion to end. NULL for promotions you want active indefinitely.
	MaximumOrdersNumber			Optional (integer)
				Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
	MaximumQuantity			Optional (integer)
				Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
	InstantDiscount			Optional (boolean)
				The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
	Coupon			Optional (string)
				Promotion coupon/voucher.
	DiscountLabel			Optional (string)
				Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
	Enabled			Optional (string)
				true or false, depending on whether a promotion is active or disabled.
	Type			Optional (string)
				REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
AdditionalFields				Optional (array of objects)
				Details below.
	Code			Optional (string)
				The alpha-numeric characters, underscores and dashes that are set as the field identifier.
	Text			Optional (string)
				Field text visible to shoppers in the cart.
	Value			Optional (string)
				Selected field value.
Currency				Optional (string)
				The currency ISO code for the payment - ISO 4217. Example: usd.
NetPrice				Optional (double)
				Order value excluding sales tax/VAT expressed in the payment currency.
GrossPrice				Optional (double)
				Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
NetDiscountedPrice				Optional (double)
				The NetPrice order value excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.
GrossDiscountedPrice				Optional (double)
				Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. For example: Currency: "usd" NetPrice: 396 GrossPrice: 486.29 NetDiscountedPrice: 376.2 GrossDiscountedPrice: 466.49 Discount: 19.8 VAT: 90.29 AffiliateCommission: 94.05
Discount				Optional (double)
				Value of the discounts for an order expressed in the payment currency.
VAT				Optional (double)
				Value of sales tax/VAT expressed in the payment currency.
AffiliateCommission				Optional (double)
				Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.

Orders with installments

Overview

2Checkout supports local Brazilian Visa, MasterCard and AMEX credit/debit cards limited to national purchases in the local currency BRL (Brazilian Real).

Requirements

Installments are available only for:
- Brazilian customers
- Local Visa, MasterCard or AMEX cards
- Non-recurring transactions
Minimum installment threshold is 5 BRL. The maximum number of installments is 6.
Mandatory information for payments also includes a shopper phone number and Fiscal Code (CPF/CNPJ).

Do local BR cards with/without installments require an addendum to my contract?

Yes. Please contact 2Checkout for activation.

How does it work?

Create the Order object.
Validate the number of installments available based on total order value.
Place the order specifying the number of installments.

Funds collection for installment payments

2Checkout pays you in full, regardless of the number of installments (this is covered directly by the banks).

Dynamic order session content object

Overview

Use this object to retrieve session content and to guide shoppers through advanced payment flows, such as those of PayPal, PayPal Express, Wire, Check, etc.

Attributes

Parameters				Type/Description
Errors				Optional (StringArray)
				Payment gateway processing errors.
Items					Array of objects
					Details below.
	ProductDetails				Object
		Name			Optional (string)
					Product name.
		ExtraInfo			Optional (string)
					The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.
		RenewalStatus			Optional (boolean)
					true for orders renewing subscriptions. false for all other orders: new purchases, upgrades.
		Subscriptions			Object
			SubscriptionReference		Optional (string)
					Unique, system-generated subscription identifier.
			PurchaseDate		Optional (string)
					The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the Avangate system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-08-11 15:18:52
			SubscriptionStartDate		Optional (string)
					Example: 2015-09-29 17:57:59
			ExpirationDate		Optional (string)
					The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-09-11 15:18:52
			Lifetime		Optional (boolean)
					true – For non-recurring, evergreen subscriptions. false – For recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Trial		Optional (boolean)
					true – For trial subscriptions. false – For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.
			Enabled		Optional (boolean)
					true – For active and past due subscriptions. false – For expired and cancelled subscriptions.
			RecurringEnabled		Optional (boolean)
					true – For subscriptions with active recurring options false – For subscriptions without recurring options.
		Tangible			Optional (boolean)
					true – For products with physical delivery. false – For products that don't require physical delivery.
		IsDynamic			Optional (boolean)
					true – For products created with dynamic information. false – For catalog products.
		ShortDescription			Optional (string)
					Short product description
		DeliveryInformation			Optional (object)
					Details below.
			Delivery		Optional (string)
					Delivery information.
			DownloadFile		Optional (object)
					Information related to the download file.
			DeliveryDescription		Optional (string)
					Delivery description.
			CodesDescription		Optional (string)
					Description of the codes delivered.
			Codes		Optional (array)
					Array with the codes delivered.
	PriceOptions				Optional (array of objects)
					Array of price option groups.
		Code			Optional (strings)
					Pricing option code.
		Required			Optional (boolean)
					true – you require shoppers to select the price option through the way in which you configured pricing. false – you do not require shoppers to select the price option.
		Options			Optional (array of objects)
					Array of pricing options.
			Name		Optional (string)
					Pricing option name.
			Value		Optional (string)
					Pricing option code.
			Surcharge		Optional (string)
					Surcharge of the pricing option. The value is not added to the product amount, but it will be stated in the cart as part of the total product price.
	Price				Object
					This object returns the price per unit at order line level. In the case of trials, the object returns the costs for the trial to full subscription conversion.
		UnitNetPrice			Optional (double)
					The value per product unit, excluding sales tax/VAT expressed in the payment currency.
		UnitGrossPrice			Optional (double)
					Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		UnitVAT			Optional (double)
					Sales tax/VAT per product unit expressed in the payment currency.
		UnitDiscount			Optional (double)
					Value of the discount per product unit expressed in the payment currency.
		UnitNetDiscountedPrice			Optional (double)
					The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which Avangate deducts the unit discount.
		UnitGrossDiscountedPrice			Optional (double)
					Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.
		UnitAffiliateCommission			Optional (double)
					Value of the affiliate commission per product unit calculated expressed in the payment currency. Avangate deducts discounts from the costs incurred by shoppers before calculating affiliate commissions. Avangate does not take into account shipping costs when calculating affiliate commissions. NULL when Avangate does not apply an affiliate commission.
		Currency			Optional (string)
					The currency ISO code for the payment - ISO 4217. Example: usd.
		NetPrice			Optional (double)
					The value per order line, excluding sales tax/VAT expressed in the payment currency.
		GrossPrice			Optional (double)
					Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
		NetDiscountedPrice			Optional (double)
					The NetPrice value per order line (in the payment currency), excluding sales tax/VAT, from which Avangate deducts discounts.
		GrossDiscountedPrice			Optional (double)
					Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. Example: UnitNetPrice: 99 UnitGrossPrice: 120.39 UnitVAT: 21.39 UnitDiscount: 9.9 UnitNetDiscountedPrice: 89.1 UnitGrossDiscountedPrice: 110.49 UnitAffiliateCommission: 22.28 Currency: "usd" NetPrice: 198 GrossPrice: 240.77 NetDiscountedPrice: 178.2 GrossDiscountedPrice: 220.97 Discount: 19.8 VAT: 42.77 AffiliateCommission: 44.56
		Discount			Optional (double)
					Value of the discounts per order line expressed in the payment currency.
		VAT			Optional (double)
					Value of sales tax/VAT per order line expressed in the payment currency.
		AffiliateCommission			Optional (double)
					Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.
	Quantity				Optional (integer)
					Number of units
	SKU				Optional (string)
					SKU identifier.
	PurchaseType				Optional (string)
					Purchase type for orders placed with dynamic information. Possible values: PRODUCT TAX COUPON SHIPPING
	ExternalReference				Optional (string)
					External order reference.
	SubscriptionStartDate				Optional (string)
					Set subscription starting date.
	CrossSell				Optional (Object)
					Details below.
		ParentCode			Optional (string)
					The product code of the master product you set to trigger the campaign.
		CampaignCode			Optional (string)
					Unique, system-generated identifier for cross-sell campaigns.
	Trial				Optional (Object)
					Details below.
		Period			Optional (integer)
					The length of the trial subscription lifetime in days.
		GrossPrice			Optional (double)
					Total trial price in the payment currency before Avangate deducts any taxes, discounts, etc.
		VAT			Optional (double)
					The total value of taxes for the trial in the payment currency, before Avangate deducts any discounts.
		NetPrice			Optional (double)
					Total trial price in the payment currency, not including taxes, before Avangate deducts any discounts.
	AdditionalFields				Optional (array of objects)
					Details below.
		Code			Optional (string)
					The alpha-numeric characters, underscores and dashes that are set as the field identifier.
		Text			Optional (string)
					Field text visible to shoppers in the cart.
		Value			Optional (string)
					Selected field value.
	Promotion				Optional (object)
					Details below.
		Name			Optional (string)
					Promotion name.
		Description			Optional (string)
					Promotion description.
		StartDate			Optional (string)
					The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
		EndDate			Optional (string)
					The date when you set the promotion to end. NULL for promotions you want active indefinitely.
		MaximumOrdersNumber			Optional (integer)
					Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
		MaximumQuantity			Optional (integer)
					Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
		InstantDiscount			Optional (boolean)
					The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
		Coupon			Optional (string)
					Promotion coupon/voucher.
		DiscountLabel			Optional (string)
					Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
		Enabled			Optional (string)
					true or false, depending on whether a promotion is active or disabled.
		Type			Optional (string)
					REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
BillingDetails				Optional (Object)
				Details below.
	FirstName			Optional (string)
				Shopper name.
	LastName			Optional (string)
				Shopper surname.
	CountryCode			Optional (string)
				Shopper country. ISO 3166 two-letter code.
	State			Optional (string) – Required for US, Brazil and Romania
				The state in the shopper's country. Mandatory when you set the Billing Country to US, Brazil and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
	City			Optional (string)
				Shopper city.
	Address1			Optional (string)
				Shopper address.
	Address2			Optional (string)
				Shopper address.
	Zip			Optional (string)
				ZIP/ Postal code.
	Email			Optional (string)
				Shopper email address.
	Phone			Optional (string)
				Shopper phone number. Mandatory when you set Brazil as the Billing Country. Can be NULL.
	Company			Optional (string)
				Company name. Can be null for end users. When present, you also need to provide the FiscalCode.
	FiscalCode			Optional (string) – Required for Brazil
				• For companies, it needs to be the VAT ID. Avangate will validate the value provided and throw an error if the VAT ID is invalid/incorrect when calling setPaymentDetails. When present, you also need to provide the Company name. • Mandatory when the Billing Country is set to Brazil. For Brazilian customers it represents the Fiscal Code (CPF/CNPJ). • Can be null for end users.
DeliveryDetails				Optional (Object) Optional. When missing, Avangate uses the same details as for the BillingDetails object.
				Details below.
	FirstName			Optional (string)
				Shopper name from the delivery details.
	LastName			Optional (string)
				Shopper surname from the delivery details.
	CountryCode			Optional (string)
				Shopper country. ISO 3166 two-letter code from the delivery details.
	State			Optional (string) – Required for US, Brazil and Romania
				The state in the shopper's country from the delivery details. Mandatory when you set the Billing Country to US, Brazil and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
	City			Optional (string)
				Shopper city from the delivery details.
	Address1			Optional (string)
				Shopper address from the delivery details.
	Address2			Optional (string)
				Shopper address from the delivery details.
	Zip			Optional (string)
				ZIP/ Postal code from the delivery details.
	Email			Optional (string)
				Shopper email address from the delivery details.
	Phone			Optional (string)
				Shopper phone number from the delivery details. Mandatory when you set Brazil as the Billing Country. Can be NULL.
	Company			Optional (string)
				Company name from the delivery details. Can be null for end users. When present, you also need to provide the FiscalCode.
Promotions					Optional (Array of objects)
					Details below.
	Name				Optional (string)
					Promotion name.
	Description				Optional (string)
					Promotion description.
	StartDate				Optional (string)
					The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
	EndDate				Optional (string)
					The date when you set the promotion to end. NULL for promotions you want active indefinitely.
	MaximumOrdersNumber				Optional (integer)
					Avangate only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
	MaximumQuantity				Optional (integer)
					Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
	InstantDiscount				Optional (boolean)
					The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
	Coupon				Optional (string)
					Promotion coupon/voucher.
	DiscountLabel				Optional (string)
					Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
	Enabled				Optional (string)
					true or false, depending on whether a promotion is active or disabled.
	Type				Optional (string)
					REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
AdditionalFields					Optional (array of objects)
					Details below.
	Code				Optional (string)
					The alpha-numeric characters, underscores and dashes that are set as the field identifier.
	Text				Optional (string)
					Field text visible to shoppers in the cart.
	Value				Optional (string)
					Selected field value.
Currency					Optional (string)
					The currency ISO code for the payment - ISO 4217. Example: usd.
NetPrice					Optional (double)
					Order value excluding sales tax/VAT expressed in the payment currency.
GrossPrice					Optional (double)
					Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
NetDiscountedPrice					Optional (double)
					The NetPrice order value excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.
GrossDiscountedPrice					Optional (double)
					Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts. For example: Currency: "usd" NetPrice: 396 GrossPrice: 486.29 NetDiscountedPrice: 376.2 GrossDiscountedPrice: 466.49 Discount: 19.8 VAT: 90.29 AffiliateCommission: 94.05
Discount					Optional (double)
					Value of the discounts for an order expressed in the payment currency.
VAT					Optional (double)
					Value of sales tax/VAT expressed in the payment currency.
AffiliateCommission					Optional (double)
					Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.

Overview

Availability

Requirements

Product

Import limitations

Product

Product code

Pricing configuration

How do I import an XML file?

Parameters

Additional fields

Pricing

Product

Overview

Parameters

Response

Request

Overview

Supported payment methods

Parameters

Requirements

Overview

Parameters

Response

Request

Overview

How does this work?

Availability

Requirements

Parameters

Response

Request

Overview

Use case

Sample request

HTML

JavaScript

Demo

Overview

Parameters

Response

Request

Overview

Attributes

Overview

Requirements

Do local BR cards with/without installments require an addendum to my contract?

How does it work?

Funds collection for installment payments

Overview

Attributes

Need help?

Not yet a Verifone customer?