Skip to main content

Charge reminder

Overview

2Checkout acts as a Merchant of Record for your online products and services, therefore we send transaction-related information to shoppers (payment receipt/electronic delivery emails, invoices, etc.).

Furthermore, when checking their financial statement, your shoppers will be able to recognize transactions performed through 2Checkout by a specific identifier that most probably does not resemble the name of the website/company the shopper made the purchase from (e.g., avg8.com*website.com).

To mitigate refund/chargeback risk from shoppers who cannot associate the statement information with the payment they performed, 2Checkout sends them an email to remind of their previous purchase and notify them about the details they would be seeing on their statement.

Availability

Enabled by default if you signed up for a 2Checkout account after September 30, 2016.

We will work with you on the next steps and activation if you signed up for an account prior to September 30, 2016.

Charge Reminder Email Notification

To reduce the risk of refunds/chargebacks, 2Checkout sends out charge reminder notifications to your shoppers, notifying them, post-purchase, about the payment previously performed.

We send out two email notifications after each complete order (except for zero value orders and refunds), as follows:

  • The first notification five days after 2Checkout marks the order as complete
  • The second notification on the 5th of the first month after 2Checkout marks the order as complete

For example, if the order is complete on October 10th, 2016, the first notification will be sent on October 15th, 2016, while the second one will be sent on November 5th, 2016.

The only exception to the rule is when the first notification is sent during the first five days of the month; in this case, the second notification will not be sent, to avoid spam.

For example, if the order is complete on October 30th, 2016, we will only send one notification - on November 4th, 2016. 

Sample

Charge Reminder Sample

Preview and test email

Navigate to the Email template manager section to preview and test the charge reminder notification sent to your shoppers.

If you cannot see the email, it means 2Checkout has not yet activated it for your account.

Subscription history

Overview

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

Retrieve subscription history

Subscription history object

Parameters Type/Description

ReferenceNo

String

 

Unique, system-generated order reference number.

Type

String

 

Purchase type:

  • SALE
  • RENEWAL
  • UPGRADE

SubscriptionReference

String

 

Unique, system-generated subscription reference.

StartDate

String

 

Subscription start date(YYYY-MM-DD) - StartDate is mandatory when importing subscription data. If you changed the time zone for the 2Checkout API by editing system settings under Account settings, then the StartDate you provide must be in accordance with your custom configuration.

ExpirationDate

String

 

Subscription expiration date(YYYY-MM-DD) - ExpirationDate is mandatory when importing subscription data. If you changed the time zone for the 2Checkout API by editing system settings under Account settings, then the ExpirationDate you provide must be in accordance with your custom configuration.

Lifetime

Boolean

 

Possible values:

  • True – the subscription is evergreen

False – the subscription has a recurring billing cycle less than or equal to three years.

SKU

String

 

Stock keeping unit you defined.

DeliveryInfo

Object

 

Object with information about the delivery made to the customer - structure described below

PartnerCode

String

 

Possible values:

  • Empty = ecommerce order
  • Partner Code

Place free partner orders

Overview

In addition to enabling your partners to place free orders (with 0 value), 2Checkout also allows you to place free partner orders for:

  • New acquisitions
  • Renewals
  • Upgrades

Free partner orders can be placed even for those partners that you did not configure a credit limit, or that exceeded their credit limit.

You control the price of products, and ultimately, the costs your partners incur. Products with 0 (zero) value can result from:

  • Configuring a 100% general margin for new acquisitions, renewals and upgrades;
  • Configuring a 100% margin per product/category;
  • Editing placed orders and setting:
    • A 100% discount or entering a value equal to that of the product;
    • A 100% margin, (either 100% extra margin or a 100% default partner margin), or the sum of the two reaching 100% or enter a value equal to that of the product;
    • Forcing the Total Price of the product to be 0;
  • Configuring product pricing for new acquisitions, renewals and upgrades and setting the price to 0.

Free orders placed on behalf of your partners are confirmed automatically regardless of the per-partner order confirmation settings.

Partner invoices are also generated automatically for approved (confirmed) zero value orders you placed for your partners, regardless of the per-partner partner generation settings. When editing non-free partner orders placed, reducing their price to 0 and saving the changes will cause the partner invoices to be generated automatically (such orders need to be confirmed manually if auto-approval is not enabled).

While multiple non-free partner orders can be added to the same partner invoice, the 2Checkout system will automatically issue a standalone partner invoice for each individual free partner order.

Since no payment is required, free orders that have been confirmed will automatically move to the Complete status, giving green light to the delivery process.

If additional details are required, such as end-user information or reseller data, you or your partner will need to first attach the info, and only then will the order be considered Complete and the delivery process start.

Disable subscription for free orders

Placed partner orders with zero value cannot be canceled or refunded.

As a workaround, consider disabling the subscriptions for the orders.

  1. Go to Subscriptions Management.
  2. Run a search to identify the subscription you want to edit.
  3. Click View.
  4. Click Cancel immediately.

3D Secure flow for API orders

Overview

3D Secure is a system designed to increase the security of online transactions using cards by checking customer identities before allowing them to finalize the purchase. 3D Secure works by redirecting your customers to pages provided by their banks, where they need to enter additional security tokens or passwords to trigger the completion of the charge.

By using 3D Secure, you get additional protection from liability for fraudulent card payments, with your customers having to go through an extra layer of authentication.

Introducing Dynamic 3D Secure via API

Starting with 2Checkout API 5.0, your orders placed via API are processed automatically through the Dynamic 3D Secure flow. Dynamic 3D Secure is a mechanism that allows us to evaluate a transaction in real-time based on a range of rule parameters that are able to determine if 3D Secure should be enabled or not.

Based on specific filters set in our backend system, 3D Secure will be enabled or not on a transaction basis in real-time. The list of filters includes:

  • Credit card issuing country
  • Billing country 
  • IP country 
  • Order amount

If one of these filters is not matching with the thresholds set in the 2Checkout system, 3D Secure will be enabled. Otherwise, the transaction is considered to be safe and can go through without 3D Secure.

Availability

Placing orders via API with the 3D Secure flow is available starting with version 5 of 2Checkout's API.

Benefits

Place orders via API starting with version 5, and let Dynamic 3D Secure mechanism bring you the following advantages:

  • Increased authorization rates – we measured and observed that in specific countries the use of 3D Secure could have an overwhelmingly positive impact (United Kingdom, Russia) while in other countries it has a negative impact (United States, China).
  • Mitigated fraud risks – 3D Secure significantly decreased the fraud rate for your incoming orders.
  • Less chargeback – the use of 3D Secure can reduce the number of chargebacks in some cases (e.g. reasons like fraud/not recognized) as customers are not allowed to open a chargeback with their bank.

How it works

For credit card orders placed starting with 2Checkout API 5.0, you need to pass through additional parameters that support the Dynamic 3D Secure flow.

  1. Once the order has been placed with the customer’s billing details, in order to confirm the payment, the shopper needs to be redirected to a 3D Secure confirmation page. 
  2. The URL where the customer needs to be redirected is provided in the API response, in the PaymentMethod object, under the Authorize3DS object. 
  3. Here, the redirect URL needs to be created by taking the Href attribute (the URL of the authorization page) and adding the parameters provided in the Params object. 
  4. The key-value pairs are the parameters that need to be attached to the URL, where the key is the parameter name and the value is its value. 

For example, for the below parameters:

{
"PaymentMethod": {
    "Authorize3DS": {
    "Href": "https://api.avangate.com/5.0/scripts/credit_card/authorize",
    "Method": "GET",
    "Params": {
        "avng8apitoken": "1234567890abcdef",
            }
        }
    }
}    
    

The URL should be constructed as follows: https://api.avangate.com/5.0/scripts...34567890abcdef.

5. Once the shopper confirms the payment, they will be redirected to the URL provided by you in the Vendor3DSReturnURL. If the payment fails due to 3DS (order could not be validated), then the customer will be returned to the URL provided in Vendor3DSCancelURL.

Send the following parameters as part of the PaymentMethod object:

Parameters Description
Vendor3DSReturnURL Required (string)
  URL address to which customers are redirected after the 3DS details get validated by the bank and the order is successfully authorized.
Vendor3DSCancelURL Required (string)
  URL address to which customers are redirected if the 3DS details were not validated or the order could not be authorized.

 

Subscription upgrade

Overview

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

Retrieve upgrade options

Subscription upgrade object

Parameters Type/Description

ProductInfo

Object

               

Details below.

 

ProductId

Int

 

 

Unique, system-generated product identifier belonging to the upgrade product.

 

ProductCode

String

 

 

Unique product identifier that you control belonging to the upgrade product.

 

ProductName

String

 

 

Product name

 

ProductVersion

String

 

 

The product version number that you control.

 

ProductEnabled

Boolean

 

 

Possible values:

0 – You disabled this product.

1 – You enabled this product.

 

ProductType

String

 

 

REGULAR or BUNDLE

 

Currency

String

 

 

The currency for prices. The currency ISO code used for the payment - ISO 4217.

 

DefaultCurrency

String

 

 

The product's default currency which is set in the Control Panel. The currency ISO code to be used for the payment - ISO 4217.

 

Price

Double

 

 

Product price. Can be null for flat pricing schemes. You need to call getPrice with Quantity, Currency and Price Options parameters to get a valid price.

 

GiftOption

String

 

 

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

 

IdGroup

Int

 

 

Product Group ID number.

 

GroupName

String

 

 

The name of the Product Group.

 

ShortDescription

String

 

 

The product's short description.

 

ProductImage

String

 

 

URLs to the product images uploaded into the Avangate platform.

 

Languages

Array of strings

 

 

Array of ISO language codes for the product - ISO 639-1.

 

PriceIntervals

Array of objects

 

 

Pricing intervals.

 

PriceType

String

 

 

NET or GROSS

 

PriceSchema

String

 

 

FLAT or DYNAMIC

Quantity

Int

 

Number of units available for the upgrade order.

PriceOptions

Array of objects

 

Details below.

 

Id

String

 

 

Pricing options ID.

 

Name

String

 

 

Pricing options group name.

 

Description

String

 

 

The description of the Pricing options group

 

Required

Boolean

 

 

True or False depending on whether you set the Pricing options group asrequired or not.

 

Type

String

 

 

Pricing options group type:

  • COMBO
  • CHECKBOX
  • RADIO

INTERVAL

 

Options

Array of objects

 

 

Details below.

 

 

Name

String

 

 

 

The name of the option inside the Pricing options group

 

 

Value

String

 

 

 

The code of the option inside the Pricing options group

 

 

Default

Boolean

 

 

 

True or false.

 

 

Description

String

 

 

 

The description of the option inside the Pricing options group.

 

 

MinValue

Int

 

 

 

Start value of a scale interval.

 

 

MaxValue

Int

 

 

 

End value of a scale interval.

Additional fields

Overview

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

  Retrieve an additional field                               Retrieve assigned additional fields                              Retrieve all additional fields    

Additional fields object

Parameters Object

Label

String

 

Field text.

Code

String

 

Field identifier. Alpha-numeric chars, underscores and dashes.

Type

String

 

Field type:

  • LISTBOX
  • CHECKBOX
  • TEXT
  • HIDDEN

ApplyTo

Sting

 

  • ORDER
  • PRODUCT

Values

Array of values

 

Custom values you control.

ValidationRule

String

 

The validation rule restricting the type of information shoppers can enter in the additional field during the purchase process.

Translations

Array of objects

 

Details below.

                Label

String

 

Field text translated in the language of the Translations object.

               Values

Object

 

Custom values you control translated in the language of the Translations object.

               Language

String

 

ISO language code. (ISO 639-1 two-letter code).

 

Shipping price

Overview

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

Retrieve shipping price

Shipping price object

Parameters Type/Description
Shipping prices available

Array of objects

Details below

  Name   String
      Name of the shipping method available for the cart configuration.
  Code   String
      System-generated identified assigned to the shipping method.
  TrackingURL String
      Tracking URL defined at shipping method leve.
  Currency   String
      Currency in which shipping prices are expressed.
  PriceDetails Object
          Details below.
           Net   Object
      Shipping price for a NET price configuration.
    TotalAmount Int
      Total shipping price charged from customers for a cart configuration.
    BasePrice Int
      Shipping method base price amount.
    OverweightAmount Int
      Overweight amount applied to the purchase.
    CountrySurcharge Int
      Surcharge applied based on customer delivery country.
    WeightSurcharge Int
      Surcharged applied based on total order weight.
    OrderSurcharge Int
      Surcharged applied based on total order amount.
           Gross   Object
      Shipping price for a GROSS price configuration.
    TotalAmount Int
      Total shipping price charged from customers for a cart configuration.
    BasePrice Int
      Shipping method base price amount.
    OverweightAmount Int
      Overweight amount applied to the purchase.
    CountrySurcharge Int
      Surcharge applied based on customer delivery country.
    WeightSurcharge Int
      Surcharged applied based on total order weight.
    OrderSurcharge Int
      Surcharged applied based on total order amount.

 

Manual renewal reminder

Overview

Use the variables in the list below to customize the Manual renewal reminder 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 0 No
ALLOW_MYACCOUNT_PROMO Include or exclude myAccount information in the email body 0 No
AUTO_RENEWAL Indicates whether or not the shopper has enabled automatic renewal on the subscription 1 No
AUTO_RENEWAL_DAYS_LEFT Indicates the number of days left until date of first attempt for automatic renewal 0 No
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 0 No
AVANGATE_SUPPORT_PHONE_US Avangate US hotline number 0 No
AVANGATE_WEBSITE Avangate website http://www.avangate.com Yes
BASE_URL Merchant's full host 0 No
BUSINESS_COMPANY Avangate company name Avangate No
BUSINESS_HOTLINE Avangate support phone 0 No
BUSINESS_HOTLINEUS Avangate US hotline number 0 No
BUSINESS_SUPEMAIL Avangate support email address support@avangate.com No
BUY_NOW_LINK Short version of renewal buy link (prefilled with shopper information) https://secure.avangate.com/order/ch..._ID=xxxxxxxxxx No
BUY_NOW_LINK_RAW Renewal link prefilled with shopper information (long version) 0 No
CANCEL_RENEWAL_LINK Shopper unsubscribe link 0 No
CARD_EXPIRED Indicates whether the payment card associated to the subscription will expire during the current billing cycle 0 No
COMMERCIALNAME Merchant's commercial name Software Company Name No
COUNTRY Shopper's country used on the billing information USA No
COUPON_DISCOUNT Indicates the value of the discount (either the percentage or the fixed amount) 40 No
COUPON_DISCOUNT_CURRENCY Indicates the 3-letter code for the currency in which the discount was set 0 No
COUPON_DISCOUNT_TYPE Indicates whether the discount is PERCENT or FIXED PERCENT No
CURRENCY Order billing currency USD No
DISPLAY_MY_ACCOUNT_INFO Include or exclude myAccount information in the email body 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
EXPIRATIONDATE Subscription expiration date 42292 No
EXPIRED Indicates whether the subscription is active or past due/expired. Possible values: TRUE (for active subscriptions). 0 No
EXTERNAL_CUSTOMER_REFERENCE Unique customer identifier assigned to each customer by a vendor's system. This identifier allows the vendor support team to quickly retrieve customer details, transaction history, and account information. Alphanumeric string 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
HOTLINE_NUMBERS Array of attributes for Avangate hotline numbers 0 No
HOTLINE_NUMBERS.NG_PHONE[index1].HotlineName Countries where Avangate support information is available. 0 No
IS_IMPORTED_SUBSCRIPTION Indicates whether the subscription has been imported into Avangate system. 0 No
IS_SUBSCRIPTION_EXPIRED Indicates whether the subscription is active or not. 0 No
IS_SUBSCRIPTION_EXPIRED_OR_PASTDUE Indicates whether the subscription is active or past due/expired. Possible values: TRUE (for active subscriptions), FALSE (for past due/expired subscriptions). 0 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
LICENCECODE Subscription reference number 0 No
MERCHANT_COMMERCIAL_NAME Merchant's commercial name Some company No
MERCHANT_SUPPORT_EMAIL Merchant support email address support@some-company.com No
MERCHANT_SUPPORT_PHONE Merchant support phone number 788112233 No
MOREINFO Additional product-level fulfillment information set in the Avangate Control Panel 0 No
MYACCOUNT_URL URL for myAccount. To the BASE_URL we add /myaccount/ https://secure.avangate.com/myaccoun...m&k=xxxxxxxxxx No
MYACCOUNT_URL_UPDATE_CC URL for updating credit card information in myAccount 0 No
MY_ACCOUNT_LOGIN_EMAIL Email address used by shopper to login/signup to myAccount client@shopper.com No
MY_ACCOUNT_LOGIN_URL Avangate myAccount login/sign-up URL https://secure.avangate.com/myaccoun...m&k=xxxxxxxxxx Yes
MY_ACCOUNT_URL URL for myAccount. To the BASE_URL we add /myaccount/ https://secure.avangate.com/myaccoun...m&k=xxxxxxxxxx No
MY_ACCOUNT_URL_UPDATE_CC URL for updating credit card information in myAccount 0 No
NUMBER_OF_DAYS_UNTIL_EXPIRATION Number of days left until subscription expiration 5 No
OLD_PRODUCT_ADDITIONAL_INFO Additional fulfillment information set in the Avangate Control Panel on a product level 0 No
OLD_PRODUCT_NAME Name of the old product (that will be renewed to a different version as per settings in your Control Panel). Old product name No
OLD_PRODUCT_GROUP_CODE The Product Group Code of the product currently on the subscription.   No
OLD_PRODUCT_GROUP_NAME

The Product Group Name of the product currently on the subscription.

 

  No
ORDER_DATE Order placement date 40544 No
ORDER_DATE_STANDARD_FORMAT Standard format used for the order placement date 42292 No
ORDER_NUMBER Indicates the reference number of the initial order that generated the subscription. [9xxxxx] No
ORDER_STATUS Order status 0 No
ORIGINAL_ORDER_REFERENCE_NUMBER Indicates the reference number of the initial order that generated the licence [9xxxxx] No
PRODUCTID Product ID number 0 No
PRODUCT_EXTRA 0 0 No
PRODUCT_NAME The name of the renewal product Software Product Name No
PRODUCT_NAME_OLD Name of the old product (that will be renewed to a different version as per settings in your Control Panel). Software Product Name Old No
RENEWAL_BUY_NOW_LINK Short version of renewal buy link (prefilled with shopper information). https://secure.avangate.com/order/ch..._ID=xxxxxxxxxx Yes
RENEWAL_COUPON Shows the coupon code of the discount (if the product has a renewal promotion assigned). 1 No
RENEWAL_INTERVAL Indicates the length of a billing cycle in number of days/months (as defined for the renewed product). 6 No
RENEWAL_INTERVAL_METRIC Indicates whether the renewal interval is defined in months or days. 0 No
RENEWAL_PRICE The next renewal price of the renewal product. 29.95 No
RENEWAL_PRODUCT_NAME The name of the renewal product. Product name Yes
RENEWAL_PRODUCT_RENEWAL_PRICE The next renewal price of the renewal product. 19.95 Yes
RENEWAL_PRODUCT_RENEWAL_PRICE_OLD The catalog next renewal price (before discount). 30.99 No
RENEWAL_PRODUCT_GROUP_CODE The Product Group Code of the product that the subscription will be renewing.   No
RENEWAL_PRODUCT_GROUP_NAME The Product Group Name of the product that the subscription will be renewing.   No
RENEWAL_PROMOTION_DATA Information related to the renewal promotion assigned to the product 0 No
RENEWAL_PROMOTION_DATA.Currency Currency of the renewal promotion USD No
RENEWAL_PROMOTION_DATA.Discount Discount value applied to renewals 30 No
RENEWAL_PROMOTION_DATA.DiscountType Type of renewal discount (percentage or fixed) PERCENT No
RETRYLINK Payment retry link 0 No
RETRY_LINK Payment retry link 0 No
SHOPPER_COMPANY_BILLING Shopper's company name used on the billing information. User company No
SHOPPER_EMAIL_ADDRESS_BILLING Shopper's email address used on the billing information. client@shopper.com No
STARTDATE Indicates the date when the subscription was purchased. 40544 No
SUBSCRIPTION_AUTO_RENEWAL Indicates whether or not the shopper has enabled automatic renewal on the subscription 1 No
SUBSCRIPTION_EXPIRATION_DATE Indicates the date when the subscription expires 42292 No
SUBSCRIPTION_PURCHASE_DATE Indicates the date when the subscription was purchased 40544 No
SUBSCRIPTION_REFERENCE_NUMBER Subscription reference number 0 No
TECHEMAIL Merchant support email address support@software-company-website.com No
TECHPHONE Merchant support phone number 888-xxx-xxxx No
UNSUBSCRIBE_LINK Shopper unsubscribe link 0 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 0 No

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