| Verifone Developer Portal

Skrill

Overview

Skrill is a digital wallet that allows you to perform online payments in multiple currencies. With over 20 million wallet holders globally, Skrill offers customers a secure and easy-to-use payment environment. Shoppers can pay conveniently anytime and anywhere with their email address and password.

Availability

Skrill is available on all 2Checkout accounts. Go to Payment methods to enable it on your account.

Skrill is available worldwide, except for Japan.

Benefits

Increased market share. Appeal to and engage 20 million Skrill wallet holders globally.
Easy to use. Customers can pay using only their email address, with a seamless payment experience across mobile, tablet, and desktop devices.

Currencies

2Checkout supports Skrill payments in the following currencies:

Purchase flow

Skrill payments are supported across all 2Checkout purchase flows, including the One-page checkout without review flow.

Shoppers select the Skrill payment method during checkout and continue to the next step.
2Checkout redirects them to Skrill.
They log in to their Skrill account and confirm the payment.
Once the payment is confirmed, 2Checkout redirects shoppers to the shopping cart Thank you page.

Recurring billing

Skrill supports recurring billing for subscription renewals.

IPN

IPN notifications for orders placed with Skrill Wallet have the value SKRILL_WALLET associated with the PAYMETHOD_CODE parameter.

Refunds

Skrill supports automatic refunds.

Lead management

You can engage your customers through Lead Management campaigns, for turning unfinished payments into complete orders. More details here.

Product

Overview

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

Retrieve products by ID Retrieve products by code Search products

Product object

Parameters	Type/Description
AvangateId	String
	Unique, system-generated 2Checkout product ID. Read-only.
ProductCode	String
	The product code that you can define for each of your offerings. Needs to be unique.
ExternalReference	String
	External reference that you control when defining the product.
ProductType	String
	REGULAR or BUNDLE
ProductName	String
	The name of the product
ProductVersion	String
	The product version number
PurchaseMultipleUnits	Boolean
	Possible values: TRUE - customers can purchase multiple units of this product. FALSE - customers can purchase only one unit at a time. The default value is TRUE.
Tangible	Boolean
	Possible values: TRUE - for physical products FALSE - for digital products
	Boolean
TangibleDetails	Object
	Only for physical products. Contains information related to product's physical setup.
	UnitDetails	Array of objects
		Details on tangible setup.
	Type	String
		Product physical configuration type. Example: "WEIGHT".
	Amount	String
		Product's tangible weight. Example: "5".
	Fee	Array of objects
		Details on handling fees associated with a tangible product.
	Currency	String
		Currency of the handling fee. Example: "USD"
	Amount	String
		Handling fee amount defined on the tangible product. Example: "5".
ProductGroup	Object
	Product group information.
	Name	String
		Product group name
	Code	String
		Product group code generated when you create the group
	TemplateName	String
		Default cart template used when generating buy links for products from this group.
	Description	String
		Product group description.
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
	Product's short description.
LongDescription	String
	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 2Checkout 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, 2Checkout 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.
	Display	Object
		Contains the display settings (Active/Required) for Order/Download pages (see Type property below)
	Type	String
		Values: Download/Order
	Active	Boolean
		True or false depending on whether the assigned product field is active or not.
	Required	Boolean
		True or false depending on whether the assigned product field is required or not.
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. 2Checkout creates pricing configurations during the process when you add a product.
	Name	String
		Pricing configuration name
	Code	String
		System-generated identifier.
	Default	boolean
		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.
	UseOriginalPrices	Boolean
		True or False
	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 2Checkout 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 2Checkout 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 2Checkout 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 purchase process.
	CustomImpactOnPrice	Boolean
		True or False
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 2Checkout 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 2Checkout 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: -1 (-1 represents the 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 2Checkout system attempts to automatically charge customers for recurring costs and additional metered usage fees (in arrears). 2Checkout 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 period 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.
	IsBackupMedia	Boolean
		True or False. Depending on whether you configure the delivery of backup media 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.
	ReturnMethod	Object
		Information on the customer redirect method after a successful purchase.
	Type	String
		Possible values: DIRECT_RETURN HEADER_REDIRECT HTML_LINK
	URL	String
		Website to which customers are redirected after a successful purchase. Example: "http://mySuccessURL.com"
	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
	BackupMedia	Object (can be NULL)
		Details below.
	Code	String
		The unique backup media identifier.
	Name	String
		Name of the backup CD/DVD.
	Type	String
		Media type: CD
	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.

Product group

Overview

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

Retrieve product group Retrieve all product groups

Product group object

Parameters	Type/Description
Name	Required (string)
	The name of the product group.
Code	Optional (string)
	Unique, system-generated identifier assigned to product groups.
TemplateName	Optional (string)
	Leave empty to assign the Default Template to the product. Or use the name of an active shopping cart template.
Description	Optional (string)
	The description of the product group.

Alipay

Overview

Alipay is a third-party online payment solution (digital wallet), providing a way for millions of individuals and businesses to make and receive payments on the Internet. The Alipay model involves escrow payments, designed to reduce transaction risk for online consumers, enabling them to release funds to vendors only if they're happy with the goods they have purchased.

As of 2019, Alipay has 1.2 billion registered users (900 million users in China), generating approximately 175 million transactions per day. Alipay's market share of online payments exceeds 54% in China.

By adding Alipay to your payment methods portfolio, you can increase authorization (for both new acquisitions and recurring payments) and conversion rates in China & APAC and have access to over 600 million consumers which means more customers and sales.

Alipay now supports:

Full refunds
Partial refunds
Reverse orders
Recurring payments

Supported currencies

Alipay supports USD and CNY transactions.

Workflow

To offer Alipay to your shoppers, you need to activate this payment method from your Merchant Control Panel account.

When placing the order, shoppers in China can select 支付宝 (Alipay) as a payment option.

2. On the next page, customers can finalize the payment. They are taken to the Alipay gateway and will receive an email confirmation and more information regarding the products/services delivery.

3. Once the payment is complete, the shoppers are taken back to the 2Checkout shopping cart Finish page.

Cross-sell

Overview

Cross-selling allows you to recommend additional products to customers and increase the average order value. The 2Checkout Public API supports classic cross-sell campaigns which means you can recommend more products from your own product catalog to your shoppers.

CrossSell Object

Use the CrossSell object to recommend additional products to customers via the 2Checkout API.

Parameters

Parameter		Type/Description
MasterProducts		Array
		Array of product codes for the items you set to trigger the cross-sell campaign.
DisplayType		String
		cart – Shopping cart review – Review page finish – Thank you page
DisplayInEmail		Boolean
		True or false depending on whether you set the cross-sell campaign to display in payment receipt emails or not.
Products		Array of objects
		Details below
	ProductCode	String
		Product code for the item you set as recommended for the cross-sell campaign.
	Discount	String
		Value of the discount. This is a percentage.
	DiscountType	String
		PERCENT – you can only set discounts as a percentage from the product price.
	Type	String
		Example: Own
	AutoAdded	Boolean
	DiscountedPrice	Array of objects
		Details below.
	Currency	String
	Price	Float
	BasePrice	Array of objects
	Currency	String
	Price	Float
CampaignCode		String
		Unique, system-generated cross-sell campaign code.
Name		String
		Campaign name.
StartDate		String
		YYYY-MM-DD. The start date you set for the cross-sell campaign.
EndDate		String
		YYYY-MM-DD. The end date you set for the cross-sell campaign.
CampaignStatus		String
		The status of the cross-sell campaign.
CampaignOwnerType		String
		Campaign owner type: Can be either MERCH or AFF.

PayPal

Overview

PayPal is a real-time payment and money transfer solution available globally. Businesses and customers with PayPal accounts can easily send and receive payments online without the need to turn to more traditional payment mechanisms.

The total value of PayPal transactions in 2011 was $118 billion, generated by 110 million active registered accounts and owned by customers in 190 markets worldwide. PayPal mobile payment volume in 2011 was $4 billion, growing from $750 million in mobile payments in 2010. (Active accounts are those that have had activity in the past 12 months.)

Availability

PayPal is available as a payment method for all 2Checkout accounts and it can be activated from the Merchant Control Panel. This payment method is not available to merchants registered in countries not supported by PayPal.

Please verify whether your country or region is supported by PayPal here.

Workflow

For orders paid with PayPal, the following information is included in the order/item description fields on PayPal receipts and emails:

Vendor domain (this is the only piece of info for trial conversions)
Type of order: new purchase or renewal
Order reference number (only for new purchases)

2Checkout automatically reverses fraud-suspect PayPal orders and orders with invalid data after 14 days.

Cross-sell

Overview

Use this object to retrieve information about the cross-sell campaigns you configured for your account.

Parameters

Parameter		Type/Description
MasterProducts		Array
		Array of product codes for the items you set to trigger the cross-sell campaign.
DisplayType		String
		cart – Shopping cart review – Review page finish – Thank you page
DisplayInEmail		Boolean
		True or false depending on whether you set the cross-sell campaign to display in payment receipt emails or not.
Products		Array of objects
		Details below
	ProductCode	String
		Product code for the item you set as recommended for the cross-sell campaign.
	Discount	String
		Value of the discount. This is a percentage.
	DiscountType	String
		PERCENT – you can only set discounts as a percentage from the product price.
	Type	String
		Example: Own
	AutoAdded	Boolean
	DiscountedPrice	Array of objects
		Details below.
	Currency	String
	Price	Float
	BasePrice	Array of objects
	Currency	String
	Price	Float
CampaignCode		String
		Unique, system-generated cross-sell campaign code.
Name		String
		Campaign name.
StartDate		String
		YYYY-MM-DD. The start date you set for the cross-sell campaign.
EndDate		String
		YYYY-MM-DD. The end date you set for the cross-sell campaign.
CampaignStatus		String
		The status of the cross-sell campaign.
CampaignOwnerType		String
		Campaign owner type: Can be either MERCH or AFF.

Product promotions

Overview

Apply discounts to specific products added to the shopping cart. Volume discounts impact the unit price applied by the platform.

Availability

Available for all 2Checkout accounts, and for both Channel Manager and resellers if you (merchant) use the products in both channels.

Example

The 2Checkout system automatically applies product promotions when the shopping cart contains a product you assigned the promotion to.

The 2Checkout system applies the round up to the discount (first calculated), and not to the price.
Example:
For a product with net price, where the price = 12.99 EUR, and discount = 50%
Step 1: The 50% discount of 6.495 EUR with round-up = 6.50 EUR
Step 2: The price in the shopping cart will be 12.99- 6.50 = 6.49 EUR

Adding a product promotion

Go to Marketing tools -> Promotions -> Regular promotions.
Click Add regular promotion.
Give a suggestive title and description to your promotion. Shoppers can see the promotion title during purchase.
- Add localized promotion names for any of the supported languages. The 2Checkout shopping cart automatically displays localized promotion names based on the selected shopping cart language.
Select when you want the promotion to run. You can limit promotions to a specific time interval or let them run indefinitely. To start a promotion as soon as you mark it Active, leave the start date empty. If you don't set the end date, the promotion will stop when the maximum number of orders has been reached or will continue to run if the maximum number of orders is unlimited.
Choose whether to apply the product promotion to eCommerce orders, partner orders (Channel Manager) or both.
Choose the coupon/voucher type:
- Single - one voucher to impact multiple orders;
- Multiple - individual and unique, per-order vouchers.
Choose whether to restrict the promotion to a number of orders, or apply it for all orders. This option is only available for single coupons.
Choose whether or not to limit the promotion based on the product quantity. Any product quantity above this limit will be sold at full price.
Fill in the promotion coupon/voucher code. The maximum length of a coupon code is 255 alphanumeric characters.
- Single: enter the coupon values manually
- Multiple: either add the values manually one coupon per line or use the coupon generator available in the Control Panel to generate 5, 10, 20, 30, 50, or 100 vouchers at a time and either append them to an existing list or replace existing items. The generator creates random vouchers that resemble this: D8C10E32. 2Checkout recommends limiting the number of coupon codes to a maximum of 25000.
Select the discount type:
- Percentage
- Fixed
Choose whether or not to apply discounts automatically. Only available for single coupons. This option applies discounts to all selected products in all orders, without the need for shoppers to enter the coupon manually.
Choose whether or not to publish the promotion to the 2Checkout Affiliate Network.
Activate the promotion.
Select the products to be included in the promotion.
Click Save.

Duplicate an active promotion

Users can duplicate an active promotion in Control Panel. This will improve the user experience and simply the actions needed in order to add a new promotion.

The feature is available for users who are offering promotions and can be activated from all the pages from the Promotion tabs.

Promotions tabs

To use the feature, follow the steps below:

Go to Marketing tools -> Promotions -> Select an active promotion that you want to Save as new.
Click on Save as new button.

Promotions Save as New

3. The promotion will be cloned as Inactive; the name will be by default Copy of cloned promotion.

4. A new code will be generated.

5. Click on the Actions icon to activate the promotion.

Regular promotions actions button
6. Click on the Activate button.

7. The actions will be visible in the User Activity reports tab.

User activity reports

Affiliate promotions

Overview

Configure product promotions to be available to your Affiliate Network. This way, your affiliates can offer shoppers a better price for their promoted products.

Availability

Available for all 2Checkout accounts.

Adding an affiliate promotion

Go to Marketing tools -> Promotions -> Regular promotions.
Click Add regular promotion.
Give the promotion a suggestive title and description. Shoppers can see the promotion title during purchase.
Select when you want the promotion to run. You can limit promotions to a specific time interval or let them run indefinitely. To start a promotion as soon as you mark it Active, leave the start date empty. If you don't set the end date, the promotion will stop when the maximum number of orders has been reached or will continue to run if the maximum number of orders is unlimited.
Choose whether to apply the product promotion to eCommerce orders, partner orders (Channel Manager) or both.
Choose the coupon / voucher type:
- Single - one voucher to impact multiple orders;
- Multiple - individual and unique, per-order vouchers.
Choose whether to restrict the promotion to a number of orders, or apply it for all orders. This option is only available for single coupons.
Choose whether or not to limit the promotion based on the product quantity. Any product quantity above this limit will be sold at full price.
Fill in the promotion coupon/voucher code. The maximum length of a coupon code is 255 alphanumeric characters.
- Single: enter the coupon values manually
- Multiple: either add the values manually one coupon per line, or use the coupon generator available in the Control Panel to generate 5, 10, 20, 30, 50 or 100 vouchers at a time and either append them to an existing list or replace existing items. The generator creates random vouchers that resemble this: D8C10E32. 2Checkout recommends limiting the number of coupon codes to a maximum of 25000.
Select the discount type:
- Percentage
- Fixed
Choose whether or not to apply discounts automatically. Only available for single coupons. This option applies discounts to all selected products in all orders, without the need for shoppers to enter the coupon manually.
Choose to publish the promotion to the 2Checkout Affiliate Network.
Activate the promotion.
Select the products to be included in the promotion.
Click Save.

Overview

Availability

Benefits

Currencies

Purchase flow

Recurring billing

IPN

Refunds

Lead management

Overview

Product object

Overview

Product group object

Overview

Supported currencies

Workflow

Overview

CrossSell Object

Parameters

Overview

Availability

Workflow

Overview

Parameters

Overview

Availability

Example

Adding a product promotion

Duplicate an active promotion

Overview

Availability

Adding an affiliate promotion

Need help?

Not yet a Verifone customer?