Skip to main content

Product

Overview

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

 

Parameters Type/Description

Product

 

Object

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.

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

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 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.

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.

 

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 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 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:

  • 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 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.

 

Payment methods

Overview

Leverage 2Checkout's Monetization Platform to sell in over 200 countries and territories, in over 45 payment methods and 100 billing currencies.

 

Availability

Online Payment Methods

All online payment methods are available for 2Monetize.

Online payment methods marked with * are available for 2Sell and 2Subscribe in all listed currencies.

Offline Payment Methods

Offline payment methods marked with ** are available for 2Sell and 2Subscribe only in USD, and in all other listed currencies for 2Monetize.

Online Payment Methods

Credit/Debit Cards (With/Without Installments) Payment Methods

Payment method Availability Renewal support/recurrent billing Currencies
Visa* Worldwide Yes All from list
Visa Electron* (debit card) Worldwide No All from list
MasterCard* Worldwide Yes All from list
Maestro* Worldwide No All from list
Eurocard (Mastercard) Scandinavia, Baltic countries Yes EUR
American Express* (credit card) Worldwide Yes USD, EUR, GBP, AUD, CAD, JPY, MXN
Discover/Novus* (credit card) Worldwide (Primarily issued in USA America, it can be processed worldwide) Yes USD
Dankort /VISA (debit card) Denmark Yes EUR, DKK
Bancontact Belgium No EUR
Postepay (Visa) Italy Yes EUR
JCB (Japan Credit Bureau)* (credit card) Austria, Bahrain, Bangladesh, Bulgaria, China, Germany, Hong Kong, Indonesia, Japan, Lebanon, Mongolia, Pakistan, Philippines, Russia, Singapore, Spain, Taiwan, Thailand, Vietnam, Laos, USA, South Korea Yes USD, EUR, JPY
CB/Carte Bancaire (local debit card, formerly Carte Bleue) France Yes EUR
UnionPay China, Macau, Hong Kong, Singapore, and other markets, mostly in APAC Yes CNY/RMB, USD, EUR, GBP, AUD, CAD, CHF, JPY, PLN, SEK, RUB, BRL, ZAR
Local cards in Turkey (Visa/MasterCard) Turkey Yes TRY
Local cards in Brazil (Visa/MasterCard)* Brazil Yes BRL
Local Cards with installments in Turkey (Bonus, World, CardFinans, BankAsya,
Paraf, Maximum, Axess)
Turkey Not in combination with installments. TRY
Local Cards with installments in Brazil (Elo Card, Hipercard)* Brazil Elo Card & Hipercard support recurring billing but not in combination with installments. BRL
Local cards in India (Visa/MasterCard)*                India Yes INR
RuPay India Yes INR

Digital Wallets Payment Methods

Payment method Availability Renewal support/recurrent billing Currencies
PayPal* Worldwide Yes All from list
PayPal Express* Worldwide Yes All from list
Alipay China, Hong Kong, Taiwan Yes CNY, USD
Apple Pay Check here the list of countries where Apple Pay is available. Yes All from list
MobilePay Denmark No DKK
Vipps Norway No NOK
WeChat Pay China, Hong Kong No USD, CNY, HKD
Skrill Wallet Worldwide (except Japan) Yes EUR, USD, GBP
Neteller Worldwide (except Japan) No EUR, USD, GBP
   *All countries and regions except for the following: Afghanistan, American Samoa, Antarctica, Bangladesh, Bouvet Island, Central African Republic, China, Christmas Island, Cocos (Keeling) Islands, Crimea, Cuba, Donetsk People's Republic (DPR), Equatorial Guinea, Ghana,  Guam, Haiti, Heard Island and McDonald Islands, Iran, Iraq, Kosovo, Lebanon, Liberia, Libya, Luhansk People's Republic (LPR), Macau,  Micronesia, Myanmar, North Korea, Northern Mariana Islands, Palestine, Pakistan, Puerto Rico, Russia, Sao Tome and Principe, South Sudan, Sudan, Syria, Turkey, U.S. Virgin Islands, United Republic of Tokelau, United States Minor Outlying Islands, Western Sahara.

Online Banking Payment Methods

Payment method Availability Renewal support/recurrent billing Currencies
iDEAL The Netherlands Auto-renewal supported through Direct Debit. EUR
OP-Pohjola Finland No EUR
Nordea Finland No EUR
Danske Finland No EUR
Trustly Austria, Belgium, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, Germany, Hungary, Ireland, Italy, Latvia, Lithuania, Netherlands, Poland, Romania, Slovakia, Slovenia, Spain, Sweden, UK. No CZK, DKK, EUR, GBP, HUF, PLN, RON, SEK
QR code bank transfer  Czech Republic No CZK
Netbanking India No INR

Direct Debit Payment Methods

Payment method Availability Renewal support/recurrent billing Currencies
Direct Debit SEPA  Germany, Austria, Spain, Belgium, France, the Netherlands Yes EUR
Direct Debit UK UK Yes GBP
eCheck/ACH United States of America Yes USD

 

Offline Payment Methods

Payment method Type Availability Renewal support / recurrent billing Currencies
Wire/Bank transfer - SEPA countries** bank transfer Austria, Belgium, Cyprus, Estonia, Finland, France, Germany, Greece, Ireland, Italy, Latvia, Lithuania, Luxembourg, Malta, Netherlands, Portugal, Slovakia, Slovenia, Spain No EUR
Wire/Bank Transfer - non-SEPA countries** bank transfer Rest of the world No USD, EUR, GBP, RON, TRY
Purchase Order purchase order Worldwide No USD, EUR, GBP, RON, TRY
Boleto/Pix* cash/online Brazil No BRL
   The payment currencies available for Wire/Bank transfer depend on your merchant setup, shopper location, and payment methods. Please check with the Verifone support team on your current settings.

 


 

Sample Refund Policy

Overview

Due to industry regulations, all websites must have a viewable privacy policy and refund policy. We have created sample policies for you to use, or you can write your own, if you choose so.

Refund Policy

The refund policy explains how you handle returns, refunds, and exchanges. You can display this policy on either the product page or the checkout page of your website. 2Checkout makes every effort to refer refund requests to you, the seller, but reserves the right to issue a refund if necessary.

Though “No Refund” Policies are generally permitted, 2Checkout strongly recommends against this business practice because it often leads to high customer chargebacks. There are certain situations where 2Checkout cannot permit “No Refund” Policies. If this applies to you, 2Checkout will let you know.

Sample Refund Policy (for Goods)

This is a sample that you can use to create/customize the refund policyfor goods  to be displayed on your website:

If you are not 100% satisfied with your purchase, you can either return your order for a full refund or exchange it for something else. You can return or exchange your purchase for up to 120 days from the purchase date. Returned or exchanged products must be in the condition you received them and in the original box and/or packaging.

Sample Refund Policy (for Services)

This is a sample that you can use to create/customize the refund policy for services to be displayed on your website:

If you are not 100% satisfied with your purchase, within 120 days from the purchase date, we will fully refund the cost of your order.

 

Promotion

Overview

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

Promotion object

Parameters Type/Description

CouponCodes

Array of strings

 

Array of coupon/voucher codes when Coupon / Voucher type is Multiple. Otherwise, empty array.

ChannelType

String

 

Possible values:

  • ECOMMERCE
  • CHANNEL_MANAGER
  • ALL

CouponType

String

 

Possible values:

  • SINGLE
  • MULTIPLE

DiscountType

String

 

Possible values:

  • FIXED
  • PERCENT

Type

String

 

REGULAR

GLOBAL

SPECIAL_PRICE

PriceMatrix Array of objects (only for SPECIAL_PRICE type of promotion)
  Is generated by the getPriceMatrix call and used to set promotion special prices.

ProductCode

String
  Code of the product that is used by promotion.

PricingConfigurationCode

String
  Code of pricing configuration used by promotion; must be related to the product.

OptionHash

String
  Unique identifier of one combination of price configuration options.

Options

Array of objects
  Describes price configuration options identified by OptionHash.

GroupName

String

OptionText

String

Prices

Array of objects
  Promotion prices by currency; the price for default currency is required.

Value

Int/Required
  Decimal

Currency

String
  ISO code

Discount

Int

 

The value of the discount. Example, for a $30 USD discount 2Checkout returns the value 30 and for a 25% price cut, 2Checkout returns 25.

Products

Array

 

Array of product codes for the products impacted by the promotion.

Name

String

 

Promotion name.

Description

String

 

Promotion description.

StartDate

String

 

Starting date. The date when you set the promotion to start. Is NULL for promotions that start immediately after they're created.

EndDate

String

 

Ending date. The date when you set the promotion to end. Is NULL for promotions that you want active indefinitely.

MaximumOrdersNumber

Int

 

When the maximum number of orders is reached the promotion stops. Can be NULL if you want the promotion to apply to an unlimited number of orders.

MaximumQuantity

Int

 

Discount only applies to a specific number of product, smaller than the maximum quantity you defined. Can be NULL if you want the promotion to apply to an unlimited number units. Any extra quantity added to the cart will be sold at full price.

InstantDiscount

Boolean

 

Selecting the instant discount option will auto-apply the discount for ALL the selected products for all shoppers, without the need to enter the discount coupon.

Coupon

String

 

The promotion/voucher for which you are extracting the information.

DiscountLabel

String

 

Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.

Enabled

Boolean

 

Can be TRUE if promotion is enabled, or FALSE if otherwise.

Currency

String

 

Currency code available for the default currency of FIXED promotions. Missing for PERCENT promotions.

DefaultCurrency String
  Required for SPECIAL_PRICE promotions, represents the default currency of the promotion.

Code

String

 

Unique, system-generated identifier 2Checkout associates with promotion campaigns.

PriceThreshold

Object

 

Limits discount use only when total order value (taxes included) exceeds the threshold you configure.

 

Amount

 Decimal

 

 

The minimum threshold you defined for the default currency.

 

Currency

String

 

 

Currency code available for the default currency of custom threshold settings.

Affiliates

Overview

The Affiliates object helps you to search and extract information about your affiliates. 

The methods below will return the affiliate(s) details only if they (the affiliates) are associated with the merchant. Otherwise, they will return an error (invalid request). This will happen even if the affiliate code provided belongs to a valid affiliate from the Affiliate Network, but one that's not associated with the vendor making the calls.

Upsell

Overview

Upselling is the practice that allows you to invite your customers to purchase a higher-end product, an upgrade, or an additional item in order to make a more profitable sale. The 2Checkout Public API supports upsell campaigns through which you can recommend catalog products to your shoppers.

UpSell Object

Use the UpSell object in order to recommend products to customers via the JSON-RPC API 6.0.

Parameters

Parameter name Type Description

Name

String

Name of the upsell campaign.

StartDate

String

The date when the up-sell campaign starts, in the YYYY-MM-DD format. Can be NULL (starts immediately after enabling).

EndDate

String

The date when the up-sell campaign ends, in the YYYY-MM-DD format. Can be NULL (ends immediately after disabling).

DisplayForManualRenewals

Boolean/Integer

Flag to control if the campaign will be displayed for manual subscription renewal orders. Can be set as true/false/0/1.

Discount

Object

Discount definition object, details below:

      Type

String

Type of discount. Can be FIXED or PERCENT.

      Value

Integer

Percentage discount value (PERCENT discount only).

      Values

Array of objects

List of currency discounts (FIXED discount only), details below.

            Currency

String

Code of the currency for the related amount.

            Amount

Integer

Discount amount value for the related currency.

      DefaultCurrency

String

Code of default currency (FIXED discount only).

PrimaryProduct

Object

Main (primary) product object, details below:

      Code

String

The code of the product that the recommendation is made for

      Quantity

Integer

The quantity for the primary product. Can be 0 (standing for any quantity)

      PriceOptions

Array of objects

Price options list for the primary product, details below:

            Code

String

Price option group code.

            Options

Array of objects

Price options list, details below:

                  Code

String

Price option code.

                  Value

Integer

Price option value (for scale interval price option group only).

RecommendedProduct

Object

Recommended product object, details below:

      Code

String

The code of the recommended product.

      Quantity

Integer

The quantity for the recommended product. Can be 0 (standing for “match quantity” setting).

      PriceOptions

Array of objects

Price options list for the recommended product, details below:

            Code

String

Price option group code.

            Options

Array of objects

Price options list, details below:

                Code

String

Price option code.

                Value

Integer

Price option value (for scale interval price option group only).

Enabled

Boolean/Integer

Sets the campaign enabled or disabled. Can be set as true/false/0/1.

Description

Array of objects

List of campaign language descriptions, details below:

      Language

String

The language code.

      Text

String

The text of the description in the associated language.

UpsellingDisplayType String Set upsell settings display type. Can be overlay, interstitial.

 

 

Integrate Drupal Commerce

Overview

Integrate Drupal Commerce to be able to process payments through the 2Checkout platform in over 200 countries and more than 100 currencies. 

Drupal Commerce is revolutionary software integrating commerce, content, and community to create engaging Web experiences that bring e-retailers more traffic to drive more results. With Drupal Commerce, online retailers have a simple yet powerful platform and the flexibility to integrate a rich commerce experience anywhere within their environment.

Availability 

Before you are able to start accepting payments, you need to request and finalize the activation of your live account by completing a form, and provide information that will help us verify the business and identity of the individuals involved in your business. 

Drupal Commerce integration is available only for 2Checkout accounts that handle their own tax and invoice management (2Sell and 2Subscribe). 

Drupal Commerce Settings 

Perform the below set of instructions in your Drupal Commerce account to integrate it with 2Checkout.

  1. Download the new 2Checkout module from Github.
  2. Upload the files to your server under your store’s directory.
  3. Log in to your Drupal Commerce admin area.
  4. Navigate to Commerce → Configuration → Payment and click on Payment gateways.

drupal connector_1.png

5. On the Payment gateways page, click on Add payment gateway.

drupal connector_2.png

6. On the Add payment gateway page, select 2Checkout ConvertPlus by Verifone/2Checkout InLine by Verifone/2Checkout 2Pay.js.

drupal connector_3.png

7. Fill in the rest of the fields on the page:

  • Display name
  • Mode (select Test to be able to place test orders)
  • Merchant Code - This is the 2Checkout Merchant Code, and you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API.
  • Secret Key - (you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API)
  • Buy-Link secret Word (you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API)
  • Conditions

8. Select Enabled to activate the plugin.

9. Click Save.

About Drupal Commerce

Drupal Commerce is revolutionary software integrating commerce, content, and community to create engaging Web experiences that bring e-retailers more traffic to drive more results. With Drupal Commerce, online retailers have a simple yet powerful platform and the flexibility to integrate a rich commerce experience anywhere within their environment.

Drupal Commerce provides the structure you need to do eCommerce without any assumptions about how your business is done.

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo