| Verifone Developer Portal

Overview

Use the ProductGroup object to create/add and update/edit product groups.

Attributes

Parameters	Type/Description
ProductGroup	Object
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.

Use the variables in the list below to customize the Electronic delivery shopper email according to your needs. Check the 'Mandatory' column to see the variables that are required in your customized version of the e-mail.

Variable name	Description	Test value	Mandatory
ADDITIONAL_PRODUCT_INFO	Additional product-level fulfillment information set in the Avangate Control Panel	Additional delivery information for this product.	No
ADDRESS2	Second section of the billing address	0	No
ALLOW_MYACCOUNT_PROMO	Include or exclude myAccount information in the email body	1	No
ATTACHMENT	Indicates whether or not you configured the product keys to be sent as an email attachment. Possible values: TRUE if the email contains an attachment FALSE if the email doesn't contain an attachment	1	No
AUTO_RENEWAL	Indicates whether or not the shopper has enabled automatic renewal on the subscription	1	No
AVANGATE_ACTED_AS_RESELLER	This is mandatory content you need to keep in your emails, given Avangate acts as Reseller / Merchant of Record for online purchases on your website.	Avangate has processed your order as the authorized reseller of #merchant commercial name.	Yes
AVANGATE_COMPANY_NAME	Avangate company name	Avangate	No
AVANGATE_SUPPORT_EMAIL	Avangate support email address	support@avangate.com	No
AVANGATE_SUPPORT_PHONE	Avangate support phone	+31 88 0000008	No
AVANGATE_SUPPORT_PHONE_US	Avangate US hotline number	+1 (650) 963-5701 / (888) 247-1614	No
AVANGATE_WEBSITE	Avangate website	http://www.avangate.com	Yes
AVANGATE_LOGO	Avangate logo URL	https://secure.avangate.com/images/e...endor_logo.png	Yes
BASE_URL	Merchant's full host	https://secure.avangate.com	No
BOLETO_SLIP_URL	URL pointing to Boleto slip	0	No
BUSINESS_COMPANY	Avangate company name	Avangate	No
BUSINESS_HOTLINE	Avangate support phone	+31 88 0000008	No
BUSINESS_HOTLINEUS	* Avangate support phone for US	+1 (650) 963-5701 / (888) 247-1614	No
BUSINESS_SUPEMAIL	Avangate support email address	support@avangate.com	No
BUSINESS_WEBSITE	Avangate website	http://www.avangate.com	No
CODES	Product keys to be delivered to the shopper. Each item of the array has two values: key and description	0	No
CODES[index1].description	Product key description.	Key description	No
CODES[index1].key	Product key.	123-ABC-1key-example	No
COMMERCIALNAME	Merchant's commercial name	[Software Company Name]	No
COMPANY	Shopper's company name used on the billing information	Customer company	No
CURRENCY	Order billing currency	0	No
CURRENCY_ORIGINAL	Original order currency (applicable to refunds)	0	No
DISPLAY_MY_ACCOUNT_INFO	Include or exclude myAccount information in the email body	1	No
DOWNLOAD_INSURANCE	Indicates whether or not the purchase includes Download Insurance Service. Possible values TRUE FALSE	0	No
DOWNLOAD_LINK	Product download link	https://secure.avangate.com/?sid=xxxxxxxxx&dld	No
DOWNLOAD_LINK_DELIVERY	Indicates whether or not a download link is available. Possible values: TRUE FALSE	1	No
EMAIL	Shopper email address used on the delivery information. If no delivery information is available, the billing information is used.	example@customer-email.com	No
ENCRYPTED_MERCHANT_CODE	Encrypted merchant code	0	No
FIRSTNAME	Shopper's first name used on the delivery information	[John	No
FIRST_NAME_DELIVERY	Shopper's first name used on the delivery information	John	No
GATEWAY_ERROR_CODE	Gateway error code	GW_PROCESSING_ERROR See the full list of Possible Values	No
GATEWAY_ERROR_MESSAGE	Reason why the transaction failed. (e.g. Invalid card, insufficient funds)	Error processing the card transaction. The card account has not been debited. Card data is invalid or incomplete.	No
HAS_RENEWAL_PRODUCTS	Flag that indicates whether at least one product has renewal settings	0	No
HOTLINE_NUMBERS	Array of attributes for Avangate hotline numbers	0	No
IS_RENEWAL	Flag that indicates whether at least one product has renewal settings	0	No
LANGUAGE	Order language (abbreviated) selected by shopper	en	No
LASTNAME	Shopper's last name used on the delivery information	Doe]	No
LAST_NAME_DELIVERY	Shopper's last name used on the delivery information	Doe	No
LICENCECODE	The subscription reference	FGXYZ1234	No
MERCHANT_CITY	Merchant's city	0	No
MERCHANT_COMMERCIAL_NAME	Merchant's commercial name	[Software Company Name]	No
MERCHANT_COMPANY_NAME	Merchant's company name	0	No
MERCHANT_STREET	Merchant's street name	0	No
MERCHANT_SUPPORT_EMAIL	Merchant support email address	support@software-company-website.com	No
MERCHANT_SUPPORT_PHONE	Merchant support phone number	[888-xxx-xxxx]	No
MOREINFO	Additional product-level fulfillment information set in the Avangate Control Panel	Additional delivery information for this product.	No
MY_ACCOUNT_LOGIN_EMAIL	Email address used by shopper to login/signup to myAccount	example@customer-email.com	No
MY_ACCOUNT_LOGIN_TOKEN	Token assigned to the shopper in order to access myAccount	xxxxxxxxxxxx	No
MY_ACCOUNT_LOGIN_URL	Avangate myAccount login/sign-up URL	secure.sofware-company-website.com/myaccount/?lang=en	Yes
NAMES_OF_PRODUCTS	Names of all products in the order, comma separated	0	No
ORDERTOTAL	Total order price	0	No
ORDER_ADDITIONAL_FIELDS_TEXT	The order additional field names configured in the Avangate Control Panel	0	No
ORDER_ADDITIONAL_FIELDS_VALUE	The order additional field values filled in by the shopper	0	No
ADDRESS1	First section of the billing address	0	No
ORDER_AMOUNT	Total order price	0	No
ORDER_AMOUNT_ORIGINAL	Original order value (applicable to refunds)	0	No
ORDER_DATE	Order placement date	42563.96863	Yes
ORDER_DATE_STANDARD_FORMAT	Standard format used for the order placement date	0	No
ORDER_FLOW	Purchase flow used to place the order	0	No
ORDER_REFERENCE_NUMBER	Order reference number	[9xxxxxx]	Yes
ORDER_STATUS	Order status	0	No
ORDER_WEBSITE	Website where the shopper placed the order	http://www.software-company-website.com	Yes
PAYABLE_TO	Payee name (applicable to wire transfer)	0	No
PAYMENT_TYPE_INFO	English payment method name. Includes last four card digits (if applicable).	0	No
PRODUCT	Product data	0	No
PRODUCT.CODE	Product code	0	No
PRODUCT.CODES	Product keys to be delivered to the shopper. Each item of the array has two values: key and description	0	No
PRODUCT.DOWNLOAD_LINK	Product download link	https://secure.avangate.com/?sid=xxxxxxxxx&dld	No
PRODUCT.HAS_CODES_ATTACHED	Indicates whether or not you configured the product keys to be sent as an email attachment. Possible values: TRUE if the email contains an attachment FALSE if the email doesn't contain an attachment	1	No
PRODUCT.HAS_DOWNLOAD_LINK	Indicates whether or not a download link is available. Possible values: TRUE FALSE	1	No
PRODUCT.ID	Product ID number	4682814	No
PRODUCT.INFO	Additional product information defined by merchant when generating buy links	0	No
PRODUCT.NAME	Product name	Product Name	No
PRODUCT.NUMBER_OF_DELIVERED_PRODUCTS	Number of distinct products to be delivered to the shopper	2	No
PRODUCT.PRODUCT_OPTIONS	Product pricing options configured in the Avangate Control Panel	0	No
PRODUCT.PRODUCT_OPTIONS[index1].OptionText	Product pricing option name	option 1	No
PRODUCT.QUANTITY	Purchased product quantity	1	No
PRODUCTCODE	Product code	0	No
PRODUCTID	Product ID number	4682814	No
PRODUCTNAME	Product name	[Product Name]	No
PRODUCTQTY	Purchased product quantity	1	No
PRODUCTS[index1].LICENSE_TYPE	Type of purchased subscription	0	No
PRODUCTS[index1].SHORT_DESCRIPTION	Short product description	0	No
PRODUCTS_DATA[index1].IdProduct	Product ID number	0	No
PRODUCTS_DATA[index1].PRODUCT_SHORT_DESCRIPTION	Short product description	0	No
PRODUCTS_NO	Number of products in cart	0	No
PRODUCT_INFO	Additional product information defined by merchant when generating buy links	0	No
PRODUCT_OPTIONS	Product pricing options configured in the Avangate Control Panel	0	No
REFNO	Order reference number	[9xxxxxx]	No
RETRYLINK	Payment retry link	0	No
RETRY_LINK	Payment retry link	0	No
SELLERCITY	Merchant's city	0	No
SELLERCOMPANY	Merchant's commercial name	0	No
SELLERCOUNTRY	Merchant's country	0	No
SELLERSTREET	Merchant's street name	0	No
SELLERWEBSITE	Website where the shopper placed the order	http://www.software-company-website.com	No
SELLERZIP	Mechant's zip code	0	No
SHOPPER_ADDRESS_1_DELIVERY	First section of the delivery address	0	No
SHOPPER_ADDRESS_2_DELIVERY	Second section of the delivery address	0	No
SHOPPER_COMPANY_DELIVERY	Shopper company name used on the delivery information. If no delivery information is available. no company name is displayed.	Customer company	No
SHOPPER_EMAIL_ADDRESS_DELIVERY	Shopper email address used on the delivery information. If no delivery information is available. the billing information is used.	example@customer-email.com	No
TECHEMAIL	Merchant support email address	support@software-company-website.com	No
TECHPHONE	Merchant support phone number	[888-xxx-xxxx]	No
TO_BE_DELIVERED	Number of distinct products to be delivered to the shopper	2	No
UPLOADLINK	File upload link	0	No
UPLOAD_LINK	File upload link	0	No
USER_EMAIL	Email address used by shopper to login/signup to myAccount	example@customer-email.com	No
USER_TOKEN	Shopper token for Avangate myAccount access	xxxxxxxxxxxx	No
WEBSITE	Website where the shopper placed the order	0	No

Promotions

Overview

Use the Promotion object via JSON-RPC API 6.0 to retrieve information on discounts/promotions you set up for your account.

Parameters

Parameters		Type/Description
Promotion		Object
		Detailed below.
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
Discount		Int
		The value of the discount. Example, for a $30 USD discount Avangate returns the value 30 and for a 25% price cut, Avangate 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.
Code		String
		Unique, system-generated identifier Avangate 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.

iDEAL

Overview

Standardized online banking-based payment method tailored to users in The Netherlands. iDEAL supports online payments via secure online transfers directly between bank accounts. With the participation of ABN AMRO, bunq, ASN, ING, Knab, Rabobank, RegioBank, SNS Bank, Triodos Bank, Van Lanschot Bankiers, Moneyou and Handelsbanken, nearly 97% of the Dutch consumers can be reached with iDEAL. About 75% of the consumers of these banks use internet banking. No less than 60% of all Dutch online shoppers use iDEAL, totaling 13 million transactions monthly. iDEAL supports the one-page checkout purchase flow.

Direct Debit must be enabled on your account in order to support recurring billing.

Workflow

When placing the order, shoppers in the Netherlands can select iDeal as a payment option and choose their bank.
Customers will have to access the online banking environment of the bank they selected, and follow the instructions presented to them in order to process the transaction.

SEPA compliance

In the process of supporting recurring payments, 2Checkout also adapted the iDEAL implementation for full SEPA compliance.

Recurrent billing support

Dutch shoppers purchase subscriptions using iDEAL, and opt to be automatically charged for future renewals.
2Checkout receives the payment confirmation along with their bank account information.
2Checkout subsequently uses the bank account details received for the iDEAL transaction initially authorized to automatically charge customers through Direct Debit, collecting funds directly from their bank accounts when renewing their subscriptions.

Product group

Overview

Use the ProductGroup object to create/add and update/edit product groups.

Parameters

Parameters	Type/Description
Name	Required (string)
	The name of the product group.
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.

Shipping fees

Overview

Use this object to retrieve information about shipping fees.

Parameters

ShippingFee	Array of objects
Name	String
	The name of the shipping fee configuration.
Code	String
	Unique, system-generated shipping fee identifier.
Amount	String
	The shipping costs
Currency	String
	The currency ISO code used for shipping costs - ISO 4217.
ApplyTo	String
	Possible values: • PRODUCT • ORDER
Type	String
	Possible values: • FIXED • PERCENT

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 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
ShippingClass	Object
	Existing shipping class object with the structure detailed below.
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.
ProductImages	Array of Image objects
	Image object. Details below. Read-only.
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.
ReviewProductUrl	String
	The URL where the product can be reviewed before approval. Parameter is required if the "Enabled" property is sent as TRUE and the product needs to be reviewed by our internal teams before activation.
ReviewAdditionalDetails	String
	Additional information can be added to access the review of the product. Parameter is optional.
AdditionalFields	Array of AdditionalFieldAssigned objects
	Array of existing additional fields assigned to products. Details below.
Translations	Array of ProductTranslation objects
	Details below.
PricingConfigurations	Array of PricingConfiguration objects
	Details below. Avangate creates pricing configurations during the process when you add a product.
BundleProducts	Array of BundleProductCode objects
	Details below.
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.
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.
FulfillmentInformation	Object
	Details below. Can be NULL. Available only in Product API 2.5 and later.

ShippingClass	Object
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

Platform	Object
PlatformName	String
	The label of the platform per the product configuration.
Category	String
	Platform category per product configuration.

ProductImage	Object (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.

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

Translation	Object – ISO 639-1 two-letter code
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.

PricingConfiguration	Object
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.
PriceOptions	Array of AssignedPriceOptionGroup objects
	Details below.

Prices	Object
Regular	Array of objects
	Details below.
Renewal	Array of objects
	Details below.

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

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

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

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

BundleProducts	Object
ProductId	String
	Unique, system-generated product ID.
ProductCode	String
	Editable product code that you control.

Prices	Object - Use this object only when Pricing Configurations are not available for your account.
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.

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

SubscriptionInformation	Object NULL for bundles for which you set the following subscription management option: “Use the subscription settings of each product in the bundle”
DeprecatedProducts	Array
	Deprecated products.
BundleRenewalManagement	String
	Possible values: GLOBAL INDIVIDUAL Can be NULL.
UpgradeProductCode	String
	Code belonging to the upgrade product.
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.
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
	Details below.
RenewalEmails	Object
	Details below. Can be NULL. Available only in Product API 2.5 and later.

ContractPeriod	Object
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.
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 (can be NULL)
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.

Settings	Object (can be NULL)
ManualRenewal	Object (can be NULL)
	Details below.
AutomaticRenewal	Object (can be NULL)
	Details below.

ManualRenewal	Object (can be NULL)
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

AutomaticRenewal	Object (can be NULL)
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

FulfillmentInformation		Object (can be NULL)
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.
CodeList		Object (can be NULL)
		Details below.
BackupMedia		Object (can be NULL)
		Details below.
ProductFile		Object (can be NULL)
		Details below.
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.

CodeList	Object (can be NULL)
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)
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)
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.

Customer

Overview

Use the object below to create, update and retrieve customers in 2Checkout.

Input parameters

Parameters		Type/Description
ExternalCustomerReference		Optional (string)
		Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the CUSTOMERID (case sensitive) parameter to Buy links.
FirstName		Required (string)
		Customer's first name.
LastName		Required (string)
		Customer's last name.
Company		Optional (string)
		Company name.
FiscalCode		Optional (string)
		Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates. 2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name. Can be null for end users.
Address1		Required (string)
		Customer's address.
Address2		Optional (string)
		Customer's address.
City		Required (string)
		Customer's city.
State		Optional (string)
		Customer's state. For example, "Alabama","Alaska","Arizona".
Zip		Required (string)
		Zip code.
CountryCode		Required (string)
		Customer's country code (ISO 3166 two-letter code).
Phone		Optional (string)
		Customer's phone number.
Fax		Optional (string)
		Customer's fax number.
Email		Required (string)
		Customer's email.
Enabled		Optional (boolean)
		true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription. Possible customer statuses: Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active. Inactive - All subscriptions associated to this Customer account are cancelled, expired or both. Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.
Trial		Optional (boolean)
		true or false, depending on whether the customer account features only trials or also paid subscriptions.
Language		Optional (string)
		ISO 639-1 two-letter code. Example: “en.”
Credit		Optional (object)
		Contains information about the credit limit, remaining credit and credit currency.
	Limit	Float
		The limit must be 0 or a positive number.
	Remaining	Float
		The remaining must be a valid number.
	Currency	String
		Currency code must be one of the transactional currencies set on account.

URL affiliate checker & tracking

Overview

Use the URL Affiliate Checker to keep track of sales generated by members of the 2Checkout Affiliate Network for services/products that you sell using a third-party e-commerce platform.

3rd party e-commerce provider -> URL affiliate checker -> detects 2Checkout cookie -> 2Checkout buy links
3rd party e-commerce provider -> URL affiliate checker -> does not detect 2Checkout cookie -> third-party buy-link

Requirements

In order to use URL Affiliate Checker, the following requirements must be met:

The 2Checkout Affiliate Network is enabled for your account.
Products sold through a third-party platform and available to 2Checkout Affiliates must be configured within the 2Checkout platform as well, and need to be assigned to commissions lists associated with 2Checkout Affiliates. Make sure to specify a commission you're willing to pay for affiliate referrals.

How does the URL Affiliate Checker work?

The URL Affiliate Checker enables you to redirect shoppers to 2Checkout ordering pages when they're referred by a 2Checkout Affiliate. The 2Checkout system tracks sales referred by affiliates and ensures that they get rewarded correctly and receive commissions for sales generated.

Installing the URL Affiliate Checker

To install the URL Affiliate Checker replace the Buy-buttons links (the buy-links placed on your call to actions) with the Affiliate Checker links generated using the Control Panel. Essentially, you need to replace the links on the buy-buttons that point to the third-party shopping cart. The 2Checkout system checks if shoppers come from a 2Checkout affiliate:

If shoppers are referred by a 2Checkout affiliate (a cookie is detected) they're redirected to the 2Checkout ordering link (2Checkout shopping cart);
If the Affiliate cookie is not present, the visitor will be redirected to a page of your choice.

URL Affiliate Checker link generator

Follow these steps to generate the affiliate checker link:

Generate a buy-link for your products using the 2Checkout Control Panel.
Enter the link generated into the Regular 2Checkout buy-link field.

3. Specify the URL where shoppers will be redirected in case that no 2Checkout affiliate cookie is detected.

4. Click the Generate link button and copy and paste this code replacing your regular buy links.

5. Shoppers clicking on the URL Affiliate Checker buy-links will be redirected to the 2Checkout shopping cart, if a 2Checkout affiliate ID is detected, or to the third-party shopping cart that you use.

6. Orders placed by shoppers which used the buy-links from 2Checkout affiliates will immediately be visible in the Order search area of the Control Panel.

Pricing

Overview

Update subscription plan/product pricing using the Price Options Group and the Pricing Configuration objects.

Price options group

Use this object to add/create and edit/update price options for your account.

Parameters

PriceOptionsGroup	Array of objects
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.
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.
Required	boolean
	True if you made the pricing option group mandatory.

Options	Object
Name	String
	Pricing option child name.
Description	String
	Pricing option child description.
Translations	Array of objects
	Details below.
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.
PriceImpact	Object
	Details below.
Default	Boolean
	TRUE for preselected options. Missing for options that are not preselected.

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

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

Translations	Object
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).

Price option group

Use this object to search for, retrieve information on price option groups (including those assigned to specific products) for your account.

Parameters

PriceOptionGroup	Array of objects
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.
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 PriceOption objects
	Details below.

PriceOption	Object
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	SubscriptionLifetimeImpact object
	Details below.
PriceImpact	Object
	Details below.
Default	Boolean
	TRUE for preselected options. Missing for options that are not preselected.
Name	String
	Pricing option child name.
Description	String
	Pricing option child description.
Translations	Array of objects
	Details below.

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

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

Translations	Object
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).

Pricing configuration

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

You identify a pricing configuration using its unique identifier: Code

Parameters

PricingConfiguration	Object
Name	String
	Pricing configuration name.
Code	String
	System-generated identifier. Read-only.
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.
PriceOptions	Array of objects
	Details below.

Prices	Object
Regular	Array of objects
	Details below.
Renewal	Array of objects
	Details below.

Regular	Object
Amount	Int
	The price of the product. Use -1 to delete it.
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.

Renewal	Object
Amount	Int
	The price of the product. Use -1 to delete it.
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.

PriceOptions	Object
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.
Options	StringArray
	The pricing options group option code you configured that the Avangate system uses to calculate product prices for pricing configurations without a base price.

Overview

Attributes

Overview

Parameters

Overview

Workflow

SEPA compliance

Recurrent billing support

Overview

Parameters

Overview

Parameters

Overview

Overview

Input parameters

Overview

Requirements

How does the URL Affiliate Checker work?

Installing the URL Affiliate Checker

URL Affiliate Checker link generator

Overview

Price options group

Parameters

Price option group

Parameters

Pricing configuration

Parameters

Need help?

Not yet a Verifone customer?