Skip to main content

Abandoned cart

Overview

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

Variable name Description Test value Mandatory

2CHECKOUT_CITY

2Checkout city

Amsterdam

No

2CHECKOUT_COMPANY_NAME

2Checkout company name

Avangate BV

No

2CHECKOUT_COUNTRY

2Checkout country

Netherlands

No

2CHECKOUT_OPERATIONAL_EMAIL

2Checkout operational email address

support@2checkout.com No

2CHECKOUT_STATE

2Checkout state

0

No

2CHECKOUT_WEBSITE

2Checkout website

https://www.2checkout.com

Yes

2CHECKOUT_ZIP_CODE

2Checkout ZIP code

1075 BD

No

BUSINESS_CITY

2Checkout city

Amsterdam

No

BUSINESS_COMPANY

2Checkout company name

Avangate BV

No

BUSINESS_COUNTRY

2Checkout country

Netherlands

No

BUSINESS_OPEMAIL

2Checkout operational email address

support@2checkout.com

No

BUSINESS_STATE

2Checkout state

0

No

BUSINESS_ZIP

2Checkout ZIP code

1075 BD

No

BUY_NOW_LINK

Short version of renewal buy link (prefilled with shopper information)

https://secure.2checkout.com/order/ch..._ID=xxxxxxxxxx

Yes

BUY_NOW_LINK_RAW

Renewal link prefilled with shopper information (long version)

0

No

DISCOUNT_TYPE

Promotion discount type: percentage or fixed

%

No

ENCRYPTED_MERCHANT_CODE

Encrypted merchant code

0

No

FIRSTNAME

Shopper's first name used on the billing information

John

No

FIRST_NAME_BILLING

Shopper's first name used on the billing information

John

No

HAPPY_HOURS

Promotion length (hours)

6

No

HAS_PROMOTION

Indicates whether there is a promotion associated to the lead management campaign

1

No

LASTNAME

Shopper's last name used on the billing information

Doe

No

LAST_NAME_BILLING

Shopper's last name used on the billing information

Doe

No

MERCHANT_COMMERCIAL_NAME

Merchant's commercial name

Software Company Name

No

MERCHANT_SUPPORT_PHONE

Merchant support phone number

888-xxx-xxxx

No

ORDER_WEBSITE

Website where the shopper placed the order

http://www.software-company-website.com

Yes

PRODUCTS

Products data.

0

No

PRODUCTS[index1].CURRENCY

Currency applied to the abandoned cart

USD

No

PRODUCTS[index1].HAS_PROMOTIONAL_PRICE

Indicates whether the product is included in a lead management discount campaign

0

No

PRODUCTS[index1].NAME

Product name

Test product name7

 

PRODUCTS[index1].PROMOTIONAL_PRICE

Price of the product discounted as per lead management promotion campaign

8.5

No

PRODUCTS[index1].REGULAR_PRICE

Catalog price for the product included in the abandoned cart

10

No

PRODUCTS[index1].SHORT_DESCRIPTION

Short product description

Product short description

No

PRODUCTS_DATA

0

0

No

PRODUCTS_DATA[index1].IdProduct

Product ID number

4605247

No

PRODUCTS_DATA[index1].PRICE_CURRENCY

Currency applied to the abandoned cart

USD

No

PRODUCTS_DATA[index1].PRODUCT_IMAGE

0

box-sz-av.jpg

No

PRODUCTS_DATA[index1].PRODUCT_NAME

0

Test product name7

No

PRODUCTS_DATA[index1].PRODUCT_SHORT_DESCRIPTION

Short product description

Product short description

No

PRODUCTS_DATA[index1].PROMOTIONAL_PRICE

Price of the product discounted as per lead management promotion campaign

8.5

No

PRODUCTS_DATA[index1].REGULAR_PRICE

Catalog price for the product included in the abandoned cart

10

No

PRODUCT_NAME

The name of the renewal product

Test

No

PROMOTION_COUPON

Discount coupon (if applicable)

COUPON

No

PROMOTION_DISCOUNT

Value of the promotional discount associated to the lead management campaign. Use it in conjunction with DISCOUNT_TYPE

7

No

RETRYLINK

Payment retry link

0

 

RETRY_LINK

Payment retry link

0

No

SELLERCOMPANY

Merchant's company name

Software Company Name

No

TECHPHONE

Merchant support phone number

888-xxx-xxxx

No

UNSUBSCRIBE_LINK

Shopper unsubscribe link

https://secure.2checkout.com/order/un...p?q=xxxxxxxxxx

No

UPLOADLINK

File upload link

0

No

UPLOAD_LINK

File upload link

0

No

WEBSITE

Website where the shopper placed the order

http://www.software-company-website.com

No

Managing product SKUs

Overview

Stock keeping unit or SKU is a number assigned to a particular product by a digital or physical retail store for easy identification and inventory tracking purposes. The SKU number is a string of alphanumeric characters that uniquely identify details such as price, product options and manufacturer of a particular product or service. SKUs are used in order notifications, electronic delivery, export files, etc.

SKU Manager

Managing product SKUs in the 2Checkout Platform is possible both via the Merchant Control Panel.

For companies managing large product catalogs with defined SKUs and that are making regular changes to their prices and products (new versions, new options), the manual process performed in Merchant Control Panel needs to be supported by an automatic solution as well. By using an automated flow, merchants decrease the time needed for this process, and also reduce the risk of human errors associated with the manual process.

In the 2Checkout platform, SKUs can be associated with a unique combination made up of:

  • Product identification element
  • Pricing configuration
  • Plus minimum one of the following:
    • Currency – defined as applicable to all currencies or only to specific ones
    • Volume Discounts – defined as specific quantity or intervals (applicable only according to the volume discounts that are defined at pricing configuration level)
    • Purchase Types – possible values: new purchase, renewals, upgrade and trial
    • Pricing Options – will be available considering the pricing option groups assigned to selected pricing configuration

SKU Schema

1. To import an SKU schema or to create a new one, go to your Merchant Control Panel and navigate to Dashboard → Setup → Products:

SKU1.png

2. Scroll to the product list and click on the Edit button.

SKU2.png

3. In the 'Edit product - Information' page, click on the SKU Manager link.

SKU3.png

4. In the 'SKU Manager' page, click on the Create tab to import an SKU schema or to add a new one.

SKU4.png

5. To create a new SKU schema, define the combination criteria from the Settings section below. The SKU number is a unique combination of Product ID (Product Code) plus all or one of the following: Currencies/Volume Discounts/Purchase Types/Pricing Options.

  • Click on View/Edit SKU details.
  • Input SKUs manually, then click on Save SKU schema.

SKU5.png

6. To import an SKU schema, export the .csv file, input the SKUs in your system.

SKU6.png

7. Then import back the file and the schema will be saved automatically.

SKU7.png

8. View the SKU schema with pricing (compiled automatically) in the SKU list tab.

The SKU code is recorded on each sale and sent via IPN and in email notifications, and also displayed in the 'View order' page.

Working with SKUs is especially useful when products have complex pricing options, many currencies, etc., or when working with power affiliates/price comparison portals.

Once you have your SKU schema in place, you will be able to modify or export it at any time.

Customer

Attributes

Parameters

Type/Description

CustomerDetails

Object

 

AvangateCustomerReference

Optional (Int)

 

 

System-generated Avangate customer reference.

 

null when you create a new customer. The Avangate system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions.

 

 

Aggregate subscriptions under the same Customer account by adding the AV_CUSTOMERID (case sensitive) parameter to Buy links.

 

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

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

 

ExistingCards

Optional (Array of objects)

 

 

 

 

 

TransientToken

Optional (Object)

 

 

 

Populated only with when you retrieve customer information by SSOToken.

 

 

 

Token

Optional (string)

 

 

 

 

Token for the EXISTING_PAYMENT_DATA flow. Use it to charge customers using cards they used in the past for purchases from your Avangate account.

 

 

CardType

Optional (string)

 

 

 

visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb

 

 

LastDigits

Optional (string)

 

 

 

Last four digits of the credit card.

 

 

ExpirationMonth

Optional (string)

 

 

 

Card expiration month.

 

 

ExpirationYear

Optional (string)

 

 

 

Card expiration year.

 

 

NameOnCard

Optional (string)

 

 

 

Card holder name.

 

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

 

Revenue recovery tools

Revenue Recovery Tools

With more than one out of every six-card transaction failing for one reason or another, implementing strategies to reduce and/or recover declined authorizations is one of the best investments any recurring revenue-based business can make. Just as there are many reasons for payments to fail, there are numerous ways to prevent and recover them. 

2Checkout provides recurring-revenue-based businesses with a comprehensive suite of revenue recovery tools, as well as the expertise and guidance to tailor and fine-tune your strategy to achieve industry-high revenue loss prevention and revenue recapture rates.

Revenue Recovery Tools are a set of unique features of the 2Checkout platform that are used for recovering and collecting transactional revenues lost due to poor authorization rates and include, without limiting, the following:

 

Feature Basic  2Recover Add-on
Account Updater external

Yes

Yes

Multiple retries logic

2

up to 4 (in addition to the 2 included in Basic)

Pre-expiration billing Yes Yes

2Checkout Updater

No

Yes

Dunning management 

No

Yes

Dispute prevention service

No

Yes

Authorization  Dashboard

Basic Advanced

Monthly financial statement

Note to user NOTE:  Use the instructions from this article to replicate the Monthly financial statement available in your previous Admin Area interface.

Account financial summary

Report description: Total sales and payment activity, together with chargebacks, refunds, transactions or payment fees + reserve held and reserve released.

Where do I find it in my new 2Checkout cPanel: The information is currently available in the Legacy payments history area, for payments issued from your previous Admin Area.

For payouts issued from new 2Checkout, information is available in the Payments tab.

Payment amounts funded to Seller

Report description: The Payment Amounts Funded to Seller section provides a high-level overview of the payouts received from 2Checkout. Reserve values represent only the amount held or released for each payment.

Where do I find it in my new 2Checkout cPanel: The information is currently available in the Legacy payments history area, for payments issued from your previous Admin Area.

For payouts issued from new 2Checkout, information is available in the Payments tab.

Submitted Transactions by Payment Type

Report description: Gross/Net Sales, Refunds and chargebacks – both order count and amount – split by payment method.

Where do I find it in new 2Checkout: The information is available in cPanel, in one of our platform defined reports:

What's new: Merchants can divide the report data on days/weeks. Merchants are also able to run the report based on other filters (products, customer country/region, order currency/language, and many others).

Chargeback Summary

Report description: This summary shows the original date and transaction the chargeback was levied against, as well as the reason for the chargeback and any fee associated with it.

Where do I find it in new 2Checkout: The information is available in cPanel, in one of our platform defined reports :

What's new: Ability to run the report based on chargeback status, reason, product, currency or payment method. Merchants are also able to see a list of potential disputes.

Transaction Fee Summary

Report description: The Transaction Fee Summary identifies all fee types accrued during a given month, how many transactions were charged each fee, the total amount charged for each fee and an accumulative total of all fees charged.

Where do I find it in new 2Checkout: Available in the Revenue Split Report, from the cPanel.

What's new: Ability to combine the fees with total sales – while displaying the report based on transactional and payout currency.

Adjustments Summary

Report description: The Adjustment Summary recaps the total gross adjustments, which can be either positive or negative, applied to the seller's account.

Where do I find it in new 2Checkout: The information is available in Accounting > Accounting summary.

Detailed Listing of Transactions

Report description: The Detailed Listing of Transactions is a comprehensive record of all settled transactions applied to your seller account during a given month.

Where do I find it in new 2Checkout: Information available in cPanel > Order search.

Added value: Merchants are able to export extended level of information related to orders, as well as apply various filters during the search.

February 2020

 

Date

Release description

Type

Documentation

February 18, 2020 We've implemented the Encrypted Ephemeral Storage (EES in short), a service consumed by the Public API to generate a limited time token. The token will replace the payment details information when placing an order via API, providing merchants that use the 2Checkout API with increased security for their transactions.

Feature

Click me

February 28, 2020

We increased the number of IPN/LCN endpoints that can be set from the Merchant Control Panel, from 3 endpoints to 4, which enables merchants to increase the number of their integrations.

Patch

Click me

Click me

Product

Overview

Use the Product object to create, update and retrieve subscription plans/products for your account. Use 2Checkout's API and control the following product attributes:

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

Parameters

Use the parameters below to add new products into your 2Checkout catalog.

Parameters Type/Description

Product

 

Object/Required

Product details.

ProductCode

String/Required

 

The product code that you can define for each of your offerings. Needs to be unique.

ProductGroupCode String/Required
  The product code that you can define for each product group. Needs to be unique.
TaxCategory String/Required
  The tax category to which the product belongs.

ProductType

String/Optional

 

REGULAR or BUNDLE

Defaults to REGULAR.

ProductName

String/Required

 

The name of the product

ProductVersion

String/Optional

 

The product version number

PurchaseMultipleUnits Boolean/Optional
 

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.

ShippingClass

Object/Optional

 

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 / Optional

 

True or false depending on whether the product can be gifted or not.

ShortDescription

String / Optional

 

The product's short description

LongDescription

String / Optional

 

The product's long description

SystemRequirements

String / Optional

 

System requirements

ProductCategory

String / Optional

 

Product category

Platforms

Array of Platform objects / Optional

 

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 / Optional

 

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) / Optional

 

The URL from where shoppers can download trial software.

TrialDescription

String / Optional

 

Descriptive text entered for trials.

Enabled

Boolean / Optional

 

True/false depending on whether the products are active or disabled. When empty, 2Checkout marks the product as disabled.  

AdditionalFields

Array of AdditionalFieldAssigned objects / Optional

 

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 / Optional

 

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/Required

 

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 / Optional

 

 

Details below.

 

ProductId

String

 

 

Unique, system-generated product ID.

 

ProductCode

String

 

 

Editable product code that you control.

Fulfillment

String / Required

 

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 / Required

 

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 / Required

 

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 / Optional

 

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 / Optional

 

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.

 

 

Coupons

Overview

Use this section to handle coupons that are part of your promotions.

You can add, update or remove coupons that are configured on your promotional campaigns.

 

 

Purchase Orders

Overview

Purchase Orders are shopper-generated commercial documents set up to act as offers to acquire products/services. They contain details such as the type, quantity, pricing info, as well as additional information of the products or services you provide to customers. A Purchase Order becomes a sales contract binding the parties after you approve it.

Availability

This type of payment method is designed exclusively for business customers worldwide. Filling in the company name is mandatory when providing billing information during the purchase process.

To allow your customers to place Purchase Orders, you need to make sure this feature is active on your account. Contact 2Checkout to confirm the availability of Purchase Orders on your account.

If you need to apply specific terms to individual Purchase Orders, 2Checkout allows you to set a custom payment term to any PO, before confirming it. This feature is available on-demand, so you need to contact 2Checkout to enable it for your account.

How to enable Purchase Orders

  1. Log in to your 2Checkout Merchant Control Panel.
  2. Navigate to Setup → Ordering options → Payments methods.
  3. Scroll down to the Purchase order and enable the option by clicking on the Activate button.
  4. If the payment method is already activated, the settings will look as in the image below.

purchase order in cPanel.png

5. Since Purchase Orders involve fulfillment/delivery of the product before payment, you also need to decide on the maximum amount of time you would like to give your customers for completing payment. You can configure this option here for up to 90 days.

PO delay.png

Supported payment methods

Shoppers can pay for Purchase Orders with either one of the following payment methods:

  • Credit cards
  • PayPal
  • Wire/Bank transfer
  • Direct Debit
  • Other payment methods activated for your account

Supported currencies

While customers worldwide can use Purchase Orders, the supported transactional currencies are detailed below.

Country Currency
United States of America USD
United Kingdom GBP
Romania RON
Turkey TRY
ROW EUR/USD
   Note: The payment currencies available for Purchase Order depend on your merchant setup, shopper location, and payment methods. Please check with the Verifone support team on your current settings.

Recurring billing

2Checkout supports recurring billing (auto-renewal) for subscriptions generated with purchase orders. Customers can use purchase orders (POs) to place an order for a subscription, pay by credit cards, Direct Debit, or PayPal, and then activate automatic renewal for that subscription and the payment information on file. This means that the next automatic renewal will generate an automated charge on that card, Direct Debit or PayPal account, without a PO being issued. Also, customers can use Purchase Orders to manually renew their subscriptions. 

Purchase flow

  1. The shopper selects the Purchase Order as a payment method when placing the order. Customers using Purchase Orders (POs) as the payment method during the ordering process have the option of setting identifiers for their orders designed to track and manage purchases in their own system. The Shopper reference number or Internal PO Number entered during the ordering process will be included in:
    • The invoice generated once the order is approved
    • In the Order Search Export file
    • IPN (Instant Payment Notification)
    • Past-due Purchase Order payment notifications
    • Order level details page for the purchase
  2. 2Checkout registers the order.
  3. The shopper receives a Finalize your payment email with a pre-filled Purchase Order form that he or she must sign and send back to 2Checkout.
  4. The shopper sends the PO to 2Checkout by fax, email, or uploads it directly via a secure connection. 2Checkout automatically places the process of delivering orders for which PO was selected as the payment option on hold until the shopper provides the signed Purchase Order form.
  5. The 2Checkout anti-fraud team verifies every PO in detail. If the document uploaded is incomplete or contains incorrect details, the 2Checkout team informs the shopper about the incomplete Purchase Order form via email and provides guidance on the next steps.
  6. If you have configured your account to be notified of pending POs, you receive a notification email (sent to the email address defined under Order Notifications Email) informing you about the Purchase Order when 2Checkout approves it.
  7. The PO form will be uploaded as a part of the order it’s tied to and shared with you for confirmation. You can find it in Control Panel, on the order’s page. The shopper also receives the Purchase Order #[order reference] - status update email confirmation and more information regarding the products/services delivery.
  8. You confirm or reject the PO in the Purchase Orders area of the Control Panel, located under Orders & customers. In this section, you can also view the Purchase Order form. If you approve the PO, 2Checkout delivers the Finalize your payment – [order reference] order email to the shopper with instructions on how he or she can finalize the payment.
    • You can auto-approve purchase orders at the moment the PO form is submitted. This feature is available on-demand, so you need to contact 2Checkout to enable it for your account.
  9. The shopper finalizes the payment via one of the available payment methods.  
  • Credit/debit card
  • PayPal
  • Check
  • Bank/Wire transfer
  • Other payment methods activated for your account 

10. 2Checkout receives the payment and updates the order status to Complete.

11. You receive the payment from 2Checkout.

If shoppers don’t pay for the order within the Purchase Order time limit, the online payment methods from the Finalizing the order email don’t work anymore. Shoppers can only pay for the order through wire transfer or check after the Purchase Order time limit expires.

Canceling purchase orders

To cancel a purchase order, regardless of the purchase order status, follow the steps below.

  1. In your Merchant Control Panel, navigate to Orders & customers → Purchase orders.
  2. Search for the order you want to cancel and click its reference number.
  3. Click Cancel purchase order.

You can set a custom date for the cancelation of purchase orders after the expiration of the payment terms set by you. If the payment terms set by you (i.e. 30 days) expire, you can choose to have the PO canceled right away, skipping the 'Expired, not paid' status.

The custom period for PO cancelation can be set on-demand, so you need to contact 2Checkout to enable it for your account.

Purchase Orders Notifications

Email notifications

The 2Checkout email monitor gives you greater visibility on the emails that your customers receive from 2Checkout. You can choose to receive Purchase Order emails by simply entering the email address that you want the email forwarded to. 

If you enable the email monitor for Purchase Order emails, you will receive all of the shopper emails. 2Checkout sends follow-up emails in the following situations:

Enable the email monitor

  1. Log in to your 2Checkout Merchant Control Panel account.
  2. Go to Integrations → Webhooks and API.
  3. In the Webhooks and API window, scroll down to the Notifications section.
  4. Check the box labeled "Email monitor" to enable this module and receive copies of the emails that 2Checkout sends to your customers. The System settings section notifies you whether the email monitor is enabled or not for your account.
  5. Check the box labeled Purchase order emails and enter the email addresses in the To field. You can choose to send the emails as a Carbon copy (CC) or Blind carbon copy (BCC). Important: If you need to enter multiple email addresses you can separate them using a comma. The To field is limited to 250 characters, including commas. For greater flexibility, recipients of different email categories do not need to be the same.
  6. Click Update to save your settings.

If you enable the email monitor for Purchase Order emails, you will receive all of the shopper emails in that category in the following situations:

  • Purchase Order Confirmation – after the shopper has placed the order
  • Finalize your payment – after you have accepted the order
  • Purchase Order Status Update in the following cases:
    • You did not receive the PO and the order has expired
    • You failed to validate the order
    • You canceled the order
    • Your order confirmation is expected
    • Payment is due in 7 days
    • Payment is due in 1 day
    • Payment was due
    • The order has been canceled

Instant Payment Notifications

The 2Checkout system automatically sends IPNs (Instant Payment Notifications) based on specific processes triggered by either you or your shopper.

The IPN_PURCHASE_ORDER_INFO parameter’s values refer to the reason why the ORDERSTATUS parameter has a certain value. To see the IPN_PURCHASE_ORDER_INFO parameter in the IPN, you must first enable it from the Control Panel.

Enable IPN_PURCHASE_ORDER_INFO

  1. Log in to your 2Checkout account.
  2. Go to Account settings.
  3. Click Edit system settings.
  4. Go to IPN settings.
  5. Check the IPN_PURCHASE_ORDER_INFO checkbox
  6. Click Save.

IPN status list

For a better understanding of when 2Checkout sends IPNs, consult the table below.

Activity Order status (Control Panel) PO status (Control Panel) IPN triggered (Yes/No) IPN ORDERSTATUS IPN_PURCHASE_ORDER_INFO
Order placed by customer using PO Unfinished Awaiting form submission Yes PENDING NEW_PURCHASE_ORDER
Customer uploads PO document Unfinished Awaiting form submission No N/A N/A
PO approved by 2Checkout support team Unfinished Awaiting your confirmation No N/A N/A
PO approved by you Unfinished Awaiting payment Yes (after electronic delivery) PURCHASE_PENDING PENDING_PAYMENT
PO paid by customer Finished Complete Yes COMPLETE COMPLETE
Payment not received within time interval Unfinished Expired, not paid Yes PURCHASE_PENDING EXPIRED_NO_PAYMENT
Payment not received within time interval + 90 days Canceled Canceled, not paid Yes CANCELED EXPIRED_NO_PAYMENT
Document not received within time interval Canceled Expired, form not received Yes CANCELED EXPIRED_NO_DOCUMENT
Rejected by you Canceled Rejected Yes CANCELED REJECTED
You don’t approve nor reject the PO within time interval Canceled Expired, PO not confirmed Yes CANCELED EXPIRED_NO_CONFIRMATION
2Checkout cancels the order Canceled Canceled by 2Checkout Yes CANCELED CANCELED
You cancel the PO via API Canceled Canceled via API Yes CANCELED CANCELED_API

For POs using the 2Checkout API and setting auto-approval to false the initial status of the PO is AWAITING_UPLOAD, corresponding to an order status of Unfinished.

Purchase Orders Submission and Payment Time Limit

Shoppers have up to 90 days at their disposal to submit the signed Purchase Order form to 2Checkout, depending on the number of days you set in the Merchant Control Panel. Failure to upload the pre-filled Purchase Order form ahead of the time limit results in the cancelation of the order. Failure to process the payment ahead of the time limit does not result in the cancelation of the subscription.

Configure the submission time limit

Set the time limit to less than 90 days if you want, by following the steps below.

  1. Go to Setup -> Ordering options.
  2. Scroll down to the Purchase order enabled option. Make sure the option is enabled and enter the desired number of days for the Purchase order delay field. If you set the value to 1, the shopper receives the payment notification email only if he uploads the Purchase Order form on the same day and 2Checkout approves it.

Failure to submit the Purchase Order form ahead of the time limit set in this field results in the cancelation of the order. All purchase orders must be dated and signed according to the guidance provided in the email. If you reject a Purchase Order, the system informs shoppers that you have canceled the order.

Configure the payment time limit

This feature is available on demand. Contact 2Checkout to enable it for your account. If you need to apply specific terms to individual Purchase Orders, 2Checkout allows you to set a custom payment term to any PO, before confirming it.

After clicking Confirm PO, you can either keep the existing payment term and confirm the Purchase Order, or set a new payment term and then confirm the Purchase Order. You can see the changes you make to the payment term in the Order history section. The maximum number of days you can set as payment terms can differ for each account.

Customers can finalize transactions for POs using instant payment methods like credit cards until 2Checkout cancels the PO. 

Cancel a purchase order

You can cancel all purchase orders except those associated with Finalized orders, for which 2Checkout completed the delivery/fulfillment process and collected the payment from customers.

Shoppers receive an automatic notification with the status change reflecting the purchase order change. In those cases in which you cancel POs after approving them, 2Checkout sends shoppers an invoice reversal notification.

Purchase Orders Delivery and Payment

2Checkout fulfills/delivers orders immediately after you approve POs and generates the shopper invoices. While delivery takes place, 2Checkout continues to keep track of orders with POs, monitoring the evolution of the process until customers finalize the transactions for their purchase. 2Checkout sends customers shopper invoices and notifications encouraging them to finalize payments. Depending on when the shopper makes payments, transactions can take as much as a few months.

In order to give shoppers the chance to make all necessary payments, the 2Checkout system generates and sends out notifications of the money due once per week (7 days apart). The 2Checkout system sends the first notification email seven days before the Purchase Order time limit and calculates the time limit using the following formula:

Purchase Order vendor approval date + Purchase Order time limit  7 days

Shoppers can make the payment through credit card, check, PayPal, bank/wire transfer, direct debit, and a range of additional payment methods activated for your account.

If shoppers don’t pay for the order within the Purchase Order time limit, the online payment methods from the Finalizing the order won’t work anymore. Shoppers can only pay for the order through wire transfer or check after the Purchase Order time limit expires.

2Checkout automatically cancels expired unpaid Purchase Orders 90 days after the expiration of the Purchase Order time limit. The automatic cancelation does not apply to partially paid Purchase Orders.

2Checkout includes all orders with approved Purchase Orders that it already fulfilled/delivered into a single Draft Invoice available in the Control Panel. However, the actual payments for the orders do not accompany the Draft Invoice. Instead, 2Checkout transfers the money for orders with POs into your account once the shopper makes the necessary payments. While Draft Invoices can contain multiple orders, 2Checkout makes payments for each order individually, in accordance with the money received from your customers.

Purchase Order Invoices

The Finance documents section allows you to run reports on Purchase Order invoices based on the invoice date.

Generate purchase order reports

Generate reports on Purchase order invoices based on the invoice date in the Purchase orders section.

  1. Use the Purchase orders section to choose the invoice date or interval and click Search once you're done.
  2. The report is displayed below and it contains 10 results/page. You can extend the displayed results number to 200 results/page.
  3. To export the entire report as a CSV file you can use the Export as CSV button.
  4. Click the More info button to see more information about a specific invoice.
  5. You can also download invoices in HTML format from the Actions column.

2Checkout allows you to download multiple types of reports for each Purchase Order:

  • Products overview report
  • Orders overview report
  • Products Report

Click the corresponding download links for each of these reports to download them.

2Checkout includes all fulfilled/delivered Purchase Orders into a single Draft Invoice available in the Control Panel. However, the actual payments for the orders do not accompany the Draft Invoice. 2Checkout transfers the Purchase Order payments into your account once customers make the necessary payments. While Draft Invoices can contain multiple orders, 2Checkout processes payments for each order individually, in accordance with the payments received from your customers.

Draft invoices and paid PO information

You can find draft invoices under the PO invoices tab of the Merchant Control Panel, under Reports Center → Accounting.

2Checkout includes information on Purchase Orders into your Sales Reports, both in the body of the email and in the attached files. You can get insight into all approved Purchase Orders, as well as into the POs that 2Checkout received payments for (representing the money that 2Checkout transfers to your account with your next payment). Access info on upcoming payments for POs already paid for by shoppers in the Accounting Summary area of the CP, under  Reports center  -> Accounting.

Payments for which the Download Invoice button is greyed out are associated with purchase orders. Downloadable invoices are available for all other payment methods used by shoppers.

CRO for digital marketers

It wasn't that long ago when having a marketing plan and instinct was enough. And if you could actually demonstrate results, well, you were way ahead of the game. Those days are long gone.

Today, metrics matter. Digital marketers are under constant pressure to continually prove and improve the value of their programs. Thus the evolution of conversion rate optimization strategies.

Download this eBook on CRO for Digital Marketers. You'll learn:

  • The 5 key steps of an effective CRO program
  • Best practices for increasing both conversion rate and AOV
  • The 18-point checklist for CRO readiness

Find out why CRO is one of the best marketing investments you can make.
Get started with your own CRO program today.

cro-for-digital-marketers-ebook.png

 

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