Skip to main content

Integrate PrestaShop

Overview

Merchants can use the PrestaShop connector to integrate with 2Checkout and process orders with ConvertPlus, InLine Cart, and 2Pay.js, and provide an improved experience to their shoppers.​

Availability

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

PrestaShop Settings

Regardless you are already using the PrestaShop connector or you want to start integrating with 2Checkout, you need to follow the steps below:

1. Download the 2Checkout payment module from GitHub by clicking on the Code button and then on Download ZIP.

prestashop_connector_1New.png

2. After downloading the .zip archive, open it and extract the folder twocheckout, then archive it separately as a .zip file.

3. Sign in to your PrestaShop admin and navigate to Modules → Module Manager.

prestashop connector_2.png

4. On the Module Manager page, click on Upload module and upload the twocheckout .zip folder.

prestashop connector_3.png

prestashop connector_4.png

5. After upload, the new module will appear as shown here:

prestashop connector_5.png

6. Click on Configure to add your information:

  • Seller ID (Merchant Code)
  • Buy Link Secret Word
  • Secret Key
  • Select the cart type:
  • Select "Demo mode" if you wish to enable it. This will allow you to place test orders using test payment methods, to check your integration with 2Checkout.
  • Select the style for the API form. You can choose to use the "Default style" or you can customize it by implementing the code snippet provided there.
  1. The Seller ID is your 2Checkout Merchant Code that you can obtain by logging in to your Merchant Control Panel and navigating to Integrations → Webhooks & API. 
  2. To find the Buy Link Secret Word, log  in to your 2 Checkout Merchant Control Panel and navigate to Integrations → Webhooks & API → Secret Word . Edit your  INS Secret Word to match the Buy Link Secret Word , copy the value and paste it in the PrestaShop admin.
  3. The Secret key can be found in your 2Checkout Merchant Control Panel, right next to the Merchant Code. Copy and paste it in your PrestaShop admin.

prestashop connector_6.png

7. Once you've filled in all the information, click on Update settings at the bottom of the page.

prestashop connector_7.png

8. Test your integration by placing an order. If your set-up is correct, you will be able to see the Pay with 2Checkout option:

  • for ConvertPlus and InLine checkout flow

prestashop connector_8New.png

  • for 2Pay.js checkout flow

test prestashop api payment.png

2Checkout Settings

  1. Sign in to your 2Checkout account.
  2. Navigate to Dashboard → Integrations → Webhooks & API
  3. Follow these steps to activate Redirect URL:
  4. Click Update to save your changes.
  5. Make sure to enable the IPN webhook notification in your Merchant Control Panel
  • Log in to the 2Checkout Merchant Control Panel and navigate to Integrations → Webhooks & API
  • Scroll down to the Notifications section and enable the IPN webhook

set up IPN in merchant control panel_1.png

  • For the Payment notification type field, select IPN or Email Text & IPN, and then click on the Configure IPN button.
  • On the IPN settings page, click on the Add IPN URL button and input the IPN URL available in the configuration page in Prestashop.

set up IPN in merchant control panel_2.png

set up IPN in merchant control panel_3.png

  • Enable all triggers and response tags

set up IPN in merchant control panel_4.png

About PrestaShop

PrestaShop is an eCommerce marketplace for small and medium merchants and offers them a variety of tools to download that help them build their online businesses. Fast, efficient, and easy to use, PrestaShop’s free eCommerce solution provides everything merchants need to open, operate, and maintain a successful online store.

For more information visit PrestaShop.com.

FAQ

1. Does the new connector use webhooks?​​​

Yes, it uses IPN, so make sure you enable it from your Merchant Control Panel.

2. Do order statuses get updated on the PrestaShop side if any change occurs after place order?​​​

Yes, both order and fraud statuses are synchronized, as well as refunds.​​

3. Can I place refunds?​​​

Yes, but only from the 2Checkout Control Panel. You will be able to place refunds from the PrestaShop portal in the next release of the connector.​

4. Can I use the connector with a 2Monetize account?​​​

No, you can't. This connector is built to cover only the 2Sell and 2Subscribe accounts.

Integrate WP-Invoice

Availability

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

WP e-Commerce Settings:

  1. Download or clone the 2Checkout payment module at https://github.com/craigchristenson/2checkout-wp-invoice
  2. Upload the files under the “wp-invoice” directory to “/wp-content/plugins/wp-invoice” on your web server.
  3. In your WordPress admin select Invoice -> Settings to open your WP Invoice settings.
  4. Under Payment select 2Checkout.
  5. Enter Display Name. Example: Credit Card (Visa, MasterCard, American Express, Discover, JCB, PIN Debit) and PayPal
  6. Enter your 2Checkout Merchant Code.
  7. Enter your 2Checkout Secret Word. (Must be the same value entered on your 2Checkout Control Panel.) To obtain the Secret Word, log in to your 2Checkout Merchant Control Panel account and navigate to Integrations → Webhooks & API → Secret Word → INS Secret word.  Your INS secret word should be the same as the buy-link secret word (can be found under Dashboard → Integrations → Webhooks & API, scroll down to the Secret Word area, under the INS Secret Word). Edit your INS secret word and buy-link secret word to match each other, then copy and paste them into your WP-Invoice admin. INS secret word.png
  8. For demo sales set Demo Mode to Yes. For live sales keep Demo Mode at No.
  9. Under Direct Checkout select Yes.
  10. Copy the URL provided under “2Checkout Approved URL/INS URL”.
  11. Click Save All Settings.

2Checkout Settings:

  1. Sign in to your 2Checkout account.
  2. Navigate to Dashboard → Integrations → Webhooks & API
  3. Follow these steps to activate Redirect URL:
    • In the Redirect URL section check “Enable return after sale”
    • For Return method, select Link in the Thank You Page or Header redirect
    • Set the Approved URL to the URL provided in your WP Invoice settings (Replace http://yourdomain.com with the actual URL to your domain)
    • Click Update to save your settings
  4. In the Webhooks and API section, under the Instant Notification Service (INS) card, check the Enable Global URL box. 
  5. Enter the Approved URL (it must be the same value entered in your WP Invoice settings) as the Global URL (replace http://www.yourdomain.com with your actual website URL)
  6. Enable all triggers.
  7. Click Update to save your changes.

About WP-Invoice

WP-Invoice lets WordPress blog owners send itemized invoices to their clients. Ideal for web developers, SEO consultants, general contractors, or anyone with a WordPress blog and clients to bill. The plugin ties into WP’s user management database to keep track of your clients and their information.

For more information visit: http://wordpress.org/extend/plugins/wp-invoice/

Integrate osCommerce

Overview

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

osCommerce is an eCommerce and online store management software that helps merchants to launch their businesses.

Availability

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

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

osCommerce Settings

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

  1. Download the new 2Checkout module from Github.
  2. Upload the files to your server under your store’s directory.
  3. Log in to your osCommerce admin area.
  4. Navigate to Administration → Modules and click on Payment.
    integrate_osCommerce-connector_1.png
  5. On the Payment page, click Install on 2Checkout.
    integrate_osCommerce-connector_2.png
  6. Select 2Checkout API, 2Checkout ConvertPlus or 2Checkout InLine and click on Install Module.
    integrate_osCommerce-connector_3.png
  7. Enter your 2Checkout details:

    • 2Checkout Account ID. The 2Checkout ID is your 2Checkout Merchant Code, and you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API.
    • Secret Key (you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API)
    • Buy-Link Secret Word (you can find it in the 2Checkout Merchant Control Panel, under Integration → Webhooks and API)

    integrate_osCommerce-connector_4.png

  8. Under Test Mode select No for live sales or Yes for test sales.
  9. Click Save Changes.

2Checkout Settings

  1. Log in to your 2Checkout Merchant Control Panel.
  2. Navigate to the Integrations → Webhooks & API section.
  3. Enable the IPN webhook notification.
    • Go to Integrations → Webhooks & API
      Webhooks & API
    • Scroll down to the Notifications section and enable the IPN webhook.
    • For the Payment notification type field, select IPN or Email Text & IPN, and then click on the Configure IPN button.
    • On the IPN settings page, click on the Add IPN URL button, input the IPN URL available on the configuration page in osCommerce and select the SHA 2 / SHA 3 hash.
      Add IPN URL
    • Enable all triggers and response tags.

About osCommerce

osCommerce (Open-Source Commerce) is an eCommerce and online store management software. ​It’s one of the oldest eCommerce solutions that help merchants to launch their businesses.​ It has support for both physical and digital products, as well as services.​

osCommerce provides a complete package of solutions to different aspects of online business(features like billing, product display, multi-language options, different currencies, etc.)

Integrate SalesForce

Overview

Integrate Salesforce with 2Checkout to ensure that data on orders your shoppers place through the 2Checkout platform is readily available in your Salesforce account. You can push not only order data but also additional information such as customer and subscription info, based on a range of triggers that you control. You can then employ Salesforce capabilities to manage order data extracted from the 2Checkout platform.

Availability

The Salesforce connector is available as an add-on. Contact 2Checkout for more information. 

  • Standard - 2Checkout pushes data into Salesforce for a static collection of objects/fields.
  • Custom - 2Checkout provides support and works closely with you to define custom integrations, providing you will full control over where and how the order data is pushed into your Salesforce account.

Requirements

All requirements listed in this section are mandatory.  

Match product codes across platforms

Enter Product codes when first creating products in Salesforce. In addition, editing existing products will allow you to also change product codes Make sure the product codes of items configured in the 2Checkout Control Panel are identical to the product codes of the matching items in Salesforce.

Advanced integration for bundle products

The Salesforce connector supports bundled products. 2Checkout - Salesforce integrations reflect bundle sales, but also break down bundles and report order data for each product actually reaching customers. 

Price and tax data is provided only for the bundle. Products sold as a part of bundle offerings feature 0 (zero) prices and taxes.

2Checkout Price Book

Price Book with the name Avangate is required in Salesforce for the integration to work. All products in Salesforce that mirror those configured in the 2Checkout platform should be added to the Avangate Price Book

For 2Checkout products with base price use the value of the Default price. For 2Checkout products without base price, use the value of the first price interval, or set it to 0 (zero).

Multi-currency support

The Salesforce connector supports multiple currencies for the data extracted from the 2Checkout system and sent into Salesforce. The capability enables you to match the currencies of your sales through 2Checkout with the currencies in Salesforce. 

To create a custom price book, follow these steps: 

  1. Login into the Salesforce platform.
  2. Navigate to Products, and in the Maintenance section at the bottom of the Products home page, click Manage Price Books.
  3. Select New, and enter the details of the price book, such as a name and a description (optional).
  4. Check Active and then click Save.
You are required to configure product prices in all currencies for the markets you're selling into, and not only for USD.

The Connector will only push your sales data into Salesforce for the products that have a price defined in the same currencies as available in the 2Checkout platform.

For example, if you configured the price of Product A as $99.99 for the US and 88.99 EUR for Europe, but only defined $99.99 in Salesforce, data for sales in EUR will not be uploaded to Salesforce. The Connector will not convert sales for sales in currencies that you haven't defined in Salesforce.

2Checkout user privileges

Access to the Salesforce connector in the 2Checkout Control Panel is only available to users with the necessary privileges. To enable access to the connector, click on Account settings, then on the Manage user access button in the User access, identify the user which you will grant Salesforce integration privileges and edit the assigned role. Check the Salesforce integration option under Setup to enable access to the Salesforce connector for a specific user.

Salesforce account

Use a Salesforce Enterprise, Developer or Unlimited account.

Salesforce user privileges

To use the Salesforce integration provided by 2Checkout, it's mandatory that you provide valid Salesforce.com account information for a user with Salesforce API privileges.

When the 2Checkout connector creates custom fields in Salesforce, it enables view/read privileges only for Admin (System Administrator) and Standard (Standard User) profiles.

Required: To make sure your Salesforce user has view/read privileges for the 2Checkout custom fields:

  1. Assign the Admin or Standard roles to the Salesforce user you utilize with the 2Checkout Salesforce connector, or,
  2. Enable view and read privileges manually for all 2Checkout custom fields in your account for your Salesforce user.

Without these privileges, custom fields will not be accessible when using the Salesforce API with your credentials, and will not be included in the WSDL.

IP addresses for 2Checkout services

2Checkout is using the following IP networks, which need to be set as allowed in your firewalls in order to connect or receive connections from 2Checkout:

  • 80.84.242.0/24
  • 91.220.121.0/25
  • 5.35.210.128/25
  • 184.106.7.192/29
  • 85.17.14.128/27

Enable the integration

Once you're done with the configuration requirements above you need to enable integration to have 2Checkout push order and subscription data into your Salesforce account.

Select 'No' at any time to pause integration and temporarily stop 2Checkout account details from reaching Salesforce.

2Checkout pushes order and subscription data into your Salesforce account only while the integration is enabled. 2Checkout does not transfer data for intervals of time when you disable the integration, however, the system queues the data and starts pushing it into your Salesforce account once you re-enable the connection beginning with the information logged after you disabled integration.

Integration data

By default the Salesforce connector pushes data for:

  • Finished and Refunded 2Checkout orders.
  • Created and Renewed subscriptions.

Salesforce integrates refunded orders in the same manner as handled by the 2Checkout system. For each refund, the 2Checkout system generates a new order with a negative value, representing the funds paid back to the shopper.

2Checkout order data is pushed into your Salesforce account at one-minute intervals but it might take a few minutes before the details are available.

Integration data triggers

Select the events for which 2Checkout pushes order and subscription data into your Salesforce account. 2Checkout is pushing data for at least the default triggers (marked in bold below).

Order triggers Subscription triggers
  1. Pending orders
  2. Approved orders (sent before electronic delivery)
  3. Authorized orders (sent after electronic delivery)
  4. Reversed orders
  5. Completed orders
  6. Canceled orders
  7. Refund orders
  1. Create subscription
  2. Renew subscription
  3. Enable/Disable subscription
  4. Enable/Disable auto-renewal
  5. Update subscription status
  6. Update expiration date
  7. Update end user

Test orders

The 2Checkout Salesforce integration supports test orders as long as you enabled the test order system.

2Checkout and Salesforce equivalents

Essentially, the details of the order pushed into Salesforce by the connector are part of the information available for exporting either as CSV (Comma Separated Values) or XLS (Excel Format) in Order search under the Orders & customers area of the 2Checkout Control Panel. The table below outlines the equivalents between the 2Checkout platform and Salesforce. 2Checkout orders will be available as Salesforce opportunities once the connector is set up and starts pushing the data.

 

2Checkout

Salesforce

Order

Opportunity

Order line

Opportunity Line Item

Order/Subscription billing details

Account

Order delivery/fulfillment details

Contact

Products

Product

Product prices

Price books

Subscription

Licence

Setup 

Access the Salesforce connector administration area by navigating to Salesforce integration under Setup.

Setup requirements

  1. A valid Salesforce account for a user with privileges to use the Salesforce API.
  2. Access to the Salesforce API requires the security token generated by Salesforce and associated with the username only when your Salesforce account also requires one. To get your security token, login into the Salesforce platform, click on your name, and in the left-hand side pane, under Personal Setup, expand My personal information, and click on Reset My Security Token. You'll receive the new security token via email.
  3. The Enterprise WSDL file describing the structure of the application on Salesforce. Note: The Enterprise WSDL file needs to be downloaded and re-uploaded into the 2Checkout Salesforce connector the first when changes are operated to the structure of the application on Salesforce. To download an enterprise WSDL file, login into Salesforce, open the drop-down button for Your Name, select Setup and in the left-hand side pane, under App Setup, click on Develop and then API. Click the Generate Enterprise WSDL link, and right-click the document displayed and choose Save as. When you have managed packages installed, you'll first need to select the Package Version for each of your installed managed packages. After clicking Generate Enterprise WSDL and then, on the next screen, hit Generate.
  4. The Metadata WSDL file associated with the Salesforce account designed to allow the modification of the structure of the Salesforce objects and fields through the API. This Metadata WSDL file is needed only in standard integration scenarios with Salesforce. To download a metadata WSDL file, open the drop-down button for Your Name, select Setup and in the left-hand side pane, under App Setup, click on Develop and then API. Click the Generate Metadata WSDL link, and right-click the document displayed and choose Save as. When you have managed packages installed, you'll first need to select the Package Version for each of your installed managed packages. After clicking Generate Enterprise WSDL and then, on the next screen, hit Generate.

Configuration

Once you have the credentials for a Salesforce account for a user with API rights, the associated security token, and the Enterprise and Metadata WSDL files, you can start setting up the connector.

  1. Enter the username and password for your Salesforce account. 
  2. Provide the security token. 
  3. Upload the Enterprise and Metadata WSDL files.
  4. Click Continue to have the 2Checkout system check whether it can establish a connection with Salesforce or not. The 2Checkout system validates all items provided, as they are used to connect to your Salesforce account.
  5. A warning will be displayed if the validation fails. In such a case please check that all the details provided are correct. Also, verify that the Enterprise and Metadata WSDL files are the same as the latest versions available through Salesforce. Make sure that the Salesforce credentials you're providing are associated with a Salesforce user with API privileges.
  6. When first setting up the 2Checkout - Salesforce integration you will be presented with a warning message informing you of the changes that the connector is designed to make to the structure of the application of Salesforce. The Salesforce connector creates a new object named License, and also adds a number of fields to existing objects. The new objects and fields are all necessary for standard integrations to order data from the 2Checkout system into Salesforce. 
  7. When you meet all requirements, 2Checkout saves the information.

The integration is limited to sending order data from the 2Checkout system only in the custom fields that it creates during the setup process. Note: order data is also pushed into required fields for Salesforce objects, and into the following standard Salesforce fields: Billing/Delivery address fields under Account as well as Billing/Mailing address fields under Contact. When the 2Checkout connector creates custom fields in Salesforce, it enables view/read privileges only for Admin (System Administrator) and Standard (Standard User) profiles.

Required: To make sure your Salesforce user has view/read privileges for the 2Checkout custom fields:

1. Assign the Admin or Standard roles to the Salesforce user you utilize with the 2Checkout Salesforce connector, or,

2. Enable view and read privileges manually for all 2Checkout custom fields in your account for your Salesforce user.

Without these privileges, custom fields will not be accessible when using the Salesforce API with your credentials, and will not be included in the WSDL.

Salesforce connector custom fields

All custom fields created by the Salesforce connector are labeled with the Avangate prefix as in the following example: Avangate_FieldName__c.

The following list provides additional details about the custom object and fields created by the 2Checkout Salesforce connector, all of which can also be created manually:

 

Account

Avangate_Record__c

  • label: Avangate record
  • type: Checkbox
  • default: false

Avangate_Company__c

  • label: Company
  • type: Text
  • length: 255

Avangate_Email__c

  • label: Email
  • type: Email
  • unique: true

Avangate_VAT_Id__c

  • label: VAT ID
  • type: Text
  • length: 25

 

Contact

Avangate_Record__c

  • label: Avangate record
  • type: Checkbox
  • default: false

 

Opportunity

Avangate_Record__c

  • label: Avangate record
  • type: Checkbox
  • default: false

Avangate_Payment_Method__c

  • label: Payment method
  • type: Text
  • length: 50

Avangate_Approval_Status__c

  • label: Approval status
  • type: Text
  • length: 25

Avangate_Order_Date__c

  • label: Order date
  • type: DateTime

Avangate_Order_Status__c

  • label: Order status
  • type: Text
  • length: 25

Avangate_Order_Finish_Date__c

  • label: Order finish date
  • type: DateTime

Avangate_Order_No__c

  • label: Order number
  • type: Number
  • scale: 0
  • precision: 11

Avangate_Total_Price__c

  • label: Total price
  • type: Number
  • scale: 2
  • precision: 11

Avangate_Reference_No__c

  • label: Reference number
  • type: Text
  • length: 11

Avangate_Currency__c

  • label: Currency
  • type: Text
  • length: 3

 

OpportunityLineItem

Avangate_Record__c

  • label: Avangate record
  • type: Checkbox
  • default: false

Avangate_Currency__c

  • label: Currency
  • type: Text
  • length: 3

Avangate_Unit_Price__c

  • label: Unit price
  • type: Number
  • scale: 2
  • precision: 11

Avangate_Total_VAT__c

  • label: Total VAT
  • type: Number
  • scale: 2
  • precision: 11

Avangate_Unit_Discount__c

  • label: Unit discount
  • type: Number
  • scale: 2
  • precision: 11

Avangate_Pricing_Options_Names__c

  • label: Pricing options names
  • type: Text
  • length: 100

Avangate_SKU__c

  • label: SKU code
  • type: Text
  • length: 25

Avangate_Pricing_Options_Values__c

  • label: Pricing options values
  • type: Text
  • length: 100

Avangate_Promotion_Coupon__c

  • label: Promotion coupon
  • type: Text
  • length: 25

Avangate_Licence_Codes__c

  • label: Licence codes
  • type: LongTextArea
  • visibleLines: 3
  • length: 5000

Avangate_Total_Without_VAT__c

  • label: Total(without VAT)
  • type: Number
  • scale: 2
  • precision: 11
 

 

Avangate_Licence__c

Avangate_Record__c

  • label: Avangate record
  • type: Checkbox
  • default: false

Avangate_Renewal_Status__c

  • label: Renewal status
  • type: Text
  • length: 25

Avangate_Purchase_Date__c

  • label: Purchase date
  • type: DateTime

Avangate_Renewal_Interval__c

  • label: Renewal interval
  • type: Text
  • length: 25

Avangate_Expiration_Date__c

  • label: Expiration date
  • type: DateTime

Avangate_Disabled__c

  • label: Disabled
  • type: Checkbox
  • default: false

Avangate_Registration_Date__c

  • label: Registration date
  • type: DateTime

Avangate_Trial__c

  • label: Trial
  • type: Checkbox
  • default: false

Avangate_License_Type__c

  • label: License type
  • type: Text
  • length: 25

Avangate_Lifetime__c

  • label: Lifetime
  • type: Checkbox
  • default: false

Avangate_Licence_Code__c

  • label: Licence code
  • type: Text
  • length: 25

Avangate_Opportunity__c

  • label: Opportunity
  • type: Lookup
  • length: 20
  • referenceTo: Opportunity
  • relationshipName: OpportunityLicences
  • relationshipOrder: 0

Avangate_Delivered_Codes__c

 

  • label: Avangate delivered codes
  • description: Text
  • type: Text
  • length: 255

Avangate_Account__c

 

  • label: Account
  • description: Licence end user
  • type: Lookup
  • length: 20
  • referenceTo: Account
  • relationshipName: LicenceAccount
  • relationshipOrder: 0

Activate the 2Checkout Salesforce integration

After the initial successful setup, the status of the connection to Salesforce is Inactive. You need to manually activate the integration for the 2Checkout system to start sending order data into Salesforce.

Activation requirements

Before activating the integration, you will need to re-download the Enterprise WSDL file and re-upload it via the Salesforce connector. This is necessary because the setup process changed the Salesforce structure, and the connector needs the most recent version of the WSDL, describing the updated Salesforce structure for your account for 2Checkout order data to be pushed correctly into the required and custom fields.

Important! Before uploading the WSDL, make sure that the custom 2Checkout fields were created and are included in the WSDL. If not, check your account privileges to make sure you have view/read privileges for the custom 2Checkout fields and re-download and re-upload the WSDL.

Data connection

2Checkout order data integration into Salesforce starts immediately after the connection configured with the Salesforce connector is activated. This date does not change, even if you disable and re-enable the connection. The Salesforce connector pushes all data for finished orders in the 2Checkout system into Salesforce from the moment of the initial activation.

What happens if I deactivate the connection?

If the connection is deactivated and then re-enabled, the connector will also push the data from the interval when the connection was disabled.

How often is the data pushed into Salesforce?

Once the connection is live, the 2Checkout system runs at periodic intervals and checks for order data that needs to be pushed into Salesforce. Details for any new finished and refunded orders identified are then transmitted and made available into Salesforce.

What happens in the case of configuration issues?

Be advised, all products need to be correctly configured in Salesforce to mirror their 2Checkout system configurations, namely share identical product codes, and be grouped into the Avangate Price Book. At the same time, orders containing products not defined in Salesforce at all will be ignored by the Salesforce connector. If a single product from an order is configured incorrectly, the Salesforce connector will not push the data for that order into Salesforce. Contact 2Checkout support directly if you notice discrepancies and follow the guidance provided to resolve product configuration issues. Once you deal with the problem, the Salesforce connector will try to push all order data into Salesforce, including details it was previously unable to integrate.

Data flow

  1. Create a new Account for orders with new billing details, or update an existing Account if the same billing details were already used in the past. The billing details are extracted from the subscription information for end-users and from the sale information for partners. Accounts are tied to the email address shoppers and partners use to place orders.
  1. Create a new Contact for orders with new delivery details, or update an existing Contact if the same delivery details were already used in the past. Multiple Contacts can be linked to a single Account. Contacts can share the same delivery email address, but be different from one another if they don't also share the contact full name (first name and last name).
  1. The Salesforce connector will now push the order data and create a new Opportunity using the information taken from the order. Opportunities are automatically linked to Account and Contact entries.
  2. Create a new Opportunity Line Item using the information taken from the order lines. A new line item is created for each product included in an order, containing all subscription codes/keys generated for that product. Order lines are linked to previously created opportunities with the product featured in each opportunity line item being linked to the correspondent Avangate Price Book entry defined in Salesforce.
  3. A new License entry is created for each generated subscription code, and linked to the corresponding opportunity.
  4. Existing Subscriptions will only be updated when new orders are placed referencing the same subscription code, such as in the case of subscription renewals or upgrades, for example.

Avangate data and Salesforce fields 

The Avangate data is mapped into Salesforce in the following fields:

Account

Name:

BillingCompany / BillingFirstName + BillingLastName

Avangate_Record__c:

Checked for orders pushed by Avangate

Avangate_Email__c:

BillingEmail

Phone:

BillingPhone

BillingStreet:

BillingAddress

BillingCity:

BillingCity

BillingState:

BillingState

BillingCountry:

BillingCountry

BillingPostalCode:

BillingZip

ShippingStreet:

DeliveryAddress

ShippingCity:

DeliveryCity

ShippingState:

DeliveryState

ShippingCountry:

DeliveryCountry

ShippingPostalCode:

DeliveryZip

Type:

Shopper type - end user or partner

Avangate_Company__c:

BillingCompany

Avangate_VAT_Id__c:

BillingVATId

 

Contact

Avangate_Record__c:

IsAvangateOrder

FirstName:

BillingFirstName

LastName:

BillingLastName

Phone:

BillingPhone

Email:

BillingEmail

MailingStreet:

BillingAddress

MailingCity:

BillingCity

MailingState:

BillingState

MailingCountry:

BillingCountry

MailingPostalCode:

BillingZip

OtherStreet:

DeliveryAddress

OtherCity:

DeliveryCity

OtherState:

DeliveryState

OtherCountry:

DeliveryCountry

OtherPostalCode:

DeliveryZip

 

Opportunity

Avangate_Record__c:

IsAvangateOrder

Avangate_Approval_Status__c:

Approval status

CloseDate:

OrderCompleteDate

Avangate_Order_Status__c:

Order status

Avangate_Order_No__c:

OrderNumber

Avangate_Reference_No__c:

OrderRefferenceNumber

Avangate_Payment_Method__c:

OrderPaymentMethod

Avangate_Order_Date__c:

OrderDate

Avangate_Order_Finish_Date__c:

OrderCompleteDate

Avangate_Total_Price__c:

TotalPrice

Avangate_Currency__c:

PaymentCurrency

StageName:

OrderApprovalStatus

 

OpportunityLineItem

Avangate_Record__c:

IsAvangateOrder

Quantity:

Quantity

Description:

Info

Avangate_Currency__c:

Currency

TotalPrice:

Avangate_Total_Without_VAT__c + Avangate_Total_VAT__c - Avangate_Unit_Discount__c * Quantity

Avangate_Unit_Price__c:

Price

Avangate_Unit_Discount__c:

Discount

Avangate_SKU__c:

SKU

Avangate_Promotion_Coupon__c:

PromotionCoupon

Avangate_Total_Without_VAT__c:

TotalWithoutVAT

Avangate_Total_VAT__c:

TotalVAT

Avangate_Pricing_Options_Names__c:

PricingOptionsText

Avangate_Pricing_Options_Values__c:

PricingOptionsValue

Avangate_Licence_Codes__c:

Purchased licence codes

 

License

Avangate_Record__c:

IsAvangateOrder

Avangate_Purchase_Date__c:

PurchaseDateTime

Avangate_Expiration_Date__c:

ExpirationDateTime

Avangate_Registration_Date__c:

DateRegistered

Avangate_Renewal_Status__c:

Auto|Manual|N/A

Avangate_Renewal_Interval__c:

Product renewal interval

Avangate_Disabled__c:

Disabled

Avangate_Trial__c:

Trial

Avangate_Lifetime__c:

Lifetime

Avangate_Licence_Code__c:

LicenceCode

Name:

LicenceCode

Avangate_Delivered_Codes__c Ativation codes delivered for the license/subscription
Avangate_Account__c Link to end user data when the license is purchased through a partner company

Re-activating the 2Checkout Salesforce connection

You have the option of deactivating the 2Checkout Salesforce connection at any time, but the integration can also be automatically deactivated by the system for reasons such as the modification of the password used for the Salesforce account set up in the connector or the resetting of the security token.

Another example of an issue that can cause the automatic deactivation of the connection is related to the Enterprise WSDL file becoming outdated due to changes operated to Salesforce objects/fields. The connection can also be dropped if the fields/objects required by the 2Checkout system for the integration are missing.

In such scenarios click the Fix account setup button and go through the steps of the setup process again, making sure that the username and password are correct, that the security token is valid, that the latest Enterprise and Metadata WSDL files are provided, and that the Salesforce user-provided has API privileges.

Note: Every time the connection is automatically deactivated, you will receive an email notification, and need to take action to resolve the issues that caused the system to disable the integration.

 

Integrate AbanteCart

Availability

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

AbanteCart Settings:

  1. Login to your AbanteCart admin.
  2. Under the Extensions menu, click Payments and select 2Checkout.
  3. Under Payment Gateways select 2Checkout.
  4. Enter your 2Checkout Account ID.
  5. Enter your INS Secret Word (Must be the same value entered on your 2Checkout Control Panel.)  To obtain the INS Secret Word, log in to your 2Checkout Control Panel and navigate to Dashboard → Integrations → Webhooks & API → Secret Word → INS Secret word.  Your INS secret word should be the same as the buy-link secret word (can be found in your Merchant Control Panel, under Dashboard → Integrations → Webhooks & API, scroll down to the Secret Word area, under the INS Secret Word). Edit your INS secret word and buy-link secret word to match each other, then copy and paste them into your AbanteCart admin.INS secret word.png
  6. Under Test mode, select live sales or testing for demo sales.
  7. Under Order Status, select Completed.
  8. Save your changes.

2Checkout Settings:

  1. Sign in to your 2Checkout account.
  2. Navigate to Dashboard → Integrations → Webhooks & API
  3. Follow these steps to activate Redirect URL:
    • In the Redirect URL section check “Enable return after sale”
    • For Return method, select Link in the Thank You Page or Header redirect
    • Set the Approved URL to the URL provided in your AbanteCart admin (Replace http://yourdomain.com with the actual URL to your domain)
    • Click Update to save your settings
  4. In the Webhooks and API section, under the Instant Notification Service (INS) card, check the Enable Global URL box. 
  5. Enter the Notifications URL provided in your AbanteCart admin as the global endpoint URL.
  6. Click Update to save your changes.

About AbanteCart

AbanteCart is a shopping cart and eCommerce application that is not only one the best and technologically advanced around, but it is also completely free, thanks to donations and contributions from satisfied users and sponsors. AbanteCart’s solution enables small to medium-sized online businesses to have a complete, multifunction eCommerce platform for absolutely no fees or subscription charges.

AbanteCart is built with unique and innovative architecture and has been designed with the user in mind. This enables people with little or no experience to use AbanteCart almost instantly. AbanteCart has also been designed with experienced users in mind and provides advanced tools with greater UI. Users do not need any programming skills, knowledge of code, or previous cart experience to use applications.

In addition to a great user interface, AbanteCart’s core code is flexible and empowered with a special extension API to allow expandability to any specific and demanding eCommerce requirement.  With this in mind, properly extended AbanteCart applications can be upgraded in the future without any hassle.

AbanteCart has rapidly become popular among small to medium-sized merchants and continues to introduce new features and extensions every day.

For more information visit: AbanteCart.com

 

Integrate VirtueMart

Availability

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

VirtueMart Settings

 

  1. Download or clone extension at https://github.com/craigchristenson/VirtueMart-2Checkout
  2. In your Joomla admin, under Extensions → Extension Manager
  3. Upload tco.zip under Upload Package File
  4. Under Components → Shop → VirtueMart → Payment Methods, click New
  5. Select 2Checkout as the Payment Method
  6. Enter a Payment Method Name
  7. Select Yes for Published
  8. Enter a Payment Description (Example: Credit Card - Visa, MasterCard, American Express, Discover, JCB, and PayPal)
  9. Click Configuration
  10. Enter your 2Checkout Seller ID (This is your Merchant code and can be found here)
  11. Enter your 2Checkout Buy-Link Secret Word (This is your INS secret word and can be found here)
  12. Set Sandbox to Yes for sandbox mode. For live sales keep Sandbox at No
  13. Set Inline Checkout to Yes to use Inline Checkout. For hosted checkout keep Inline Checkout at No
  14. (Optional) Select your preferred logo if you have one (VirtueMart Images are stored in /images/stories/virtuemart/payment)
  15. Click Save

2Checkout Settings



1.    Sign in to your 2Checkout account

2.    Navigate to the Integrations section → Webhooks & API, and go to the Redirect URL section 

3.    Under Return method, select Header Redirect

4.    Click Update to save your settings

About VirtueMart

VirtueMart is an Open Source E-Commerce solution (a Component or Plug-in) for the Joomla! Content Management System. It can be run as a Shopping Cart, or in Catalog mode. You need to install Joomla! first (as the "Framework"), and then install & configure VirtueMart.

 

Invoice

Use the variables in the list below to customize the Invoice 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
AVANGATE_LOGO Avangate logo URL https://secure.avangate.com/images/e...endor_logo.png Yes
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_SUPPORT_EMAIL

Avangate support email address

support@avangate.com

No

AVANGATE_SUPPORT_PHONE

Avangate support phone

+31 88 0000008

No

AVANGATE_WEBSITE

Avangate website

http://www.avangate.com Yes

BASE_URL

Merchant's full host

https://secure.avangate.com No

BOLETO_SLIP_URL

URL pointing to Boleto slip

1 No

BUSINESS_COMPANY

Avangate company name

Avangate No

BUSINESS_HOTLINE

Avangate support phone

+31 88 0000008

No

BUSINESS_SUPEMAIL

Avangate support email address

support@avangate.com

No

BUSINESS_WEBSITE

Avangate website

http://www.avangate.com

No

COMMERCIALNAME

Merchant's commercial name

[Software Company Name]

No

CURRENCY

Order billing currency

0 Yes

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

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

GENERALTOTAL

Total order price

135.2 No

HAS_RENEWAL_PRODUCTS

Flag that indicates whether at least one product has renewal settings

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

Merchant support email address

support@software-company-website.com No

MERCHANT_SUPPORT_PHONE

Merchant support phone number

[888-xxx-xxxx] 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

ORDERDATE

Order placement date

10/2/2018 No

ORDER_AMOUNT

Total order price

0 Yes

ORDER_AMOUNT_ORIGINAL

Original order value (applicable to refunds)

0 No

ORDER_DATE

Order placement date

10/2/2018 Yes

ORDER_DATE_STANDARD_FORMAT

Standard format used for the order placement date

10/2/2018 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_METHOD

English name for the payment method used

Visa/MasterCard/Eurocard No

PAYMENT_TYPE_INFO

English payment method name. Includes last four card digits (if applicable).

0 No

PAYTYPESTR

English name for the payment method used

[Visa/MasterCard/Eurocard] 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

PURCHASE_ORDER_MAX_DATE

Purchase Order due date

10/2/2018 No

REFNO

Order reference number

[9xxxxxx] No

RETRYLINK

Payment retry link

0 No

RETRY_LINK

Payment retry 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

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

InLine Checkout Guide

Overview

The InLine Checkout is a simple and straightforward interface that follows the latest conversion optimization best practices, removing any distracting elements during your customers' ordering process.

2Checkout makes available in merchant cPanel two inline checkout flows that you may choose from, a One-Step and a Multi-Step InLine cart, depending on the shopping experience you want your customers to benefit from via this iFrame.

  • One-Step InLine offers customers a seamless shopping experience by enabling them to select a payment method, review the entire order and finally place the order in only one step.
  • Multi-Step InLine offers a different checkout experience, in multiple steps, by allowing your customers to review their billing, shipping, and payment information before placing the order.

Recommended resources

Availability

InLine Checkout is available for accounts that have ConvertPlus enabled on their account. Contact the 2Checkout Support Team for activation.

Requirements

2Checkout merchants who already have the new InLine shopping cart enabled can generate buy links for the optimized purchase flow from the 2Checkout Control Panel.

Generate buy links

Follow the steps below to generate buy links for your products using the new shopping cart.

  1. Login to the 2Checkout Merchant Control Panel.
  2. Go to Setup -> Generate links.
  3. Click the Inline Checkout tab in the Checkout Links area.
  4. Select the products you want to generate checkout links for. In case you are using dynamic products, read the instructions from this article.
  5. Choose the product quantity.
  6. Click on Generate link.
  7. Copy the generated link and add it to your website.

Test buy links

You can test the link before adding it to your website in multiple ways:

  • Copy the link and paste it into your browser’s address bar.
  • Click on Test link to open it in a new browser tab.
  • Scan the QR code with a smartphone app to view the checkout page on a mobile device.

Supported payment methods

InLine Checkout supports the following payment methods:

  • Credit/debit card
    • Visa
    • Visa Electron
    • MasterCard
    • Maestro
    • American Express
    • JCB
    • Discover
    • UnionPay
  • PayPal
  • PayPal Express
  • Bank/Wire transfers
  • SEPA Direct Debit
  • iDEAL
  • Boleto/Pix
  • Credit cards with installments
  • Apple Pay
  • Alipay

The InLine Checkout is optimized to display popular payment methods based on shopper location. This makes it easier for customers to complete a purchase using their favorite payment method, which will result in a higher conversion rate for you.

Purchase flow

The checkout experience is ensured by a one-page checkout flow that enables shoppers to quickly finalize their purchases without spending too much time in the shopping cart.

  1. Shoppers add the products to their cart.
  2. Once they reach the shopping cart they can select product options/plans and add a coupon code (if applicable).
  3. They select the payment method.
    • If they choose to pay by card, they enter the billing and card information and finish the payment.
    • If they choose to pay through PayPal, 2Checkout automatically takes them to PayPal’s login page where they have to agree and continue with the payment. Afterwards, the shoppers will be redirected to the 2Checkout shopping cart to complete the purchase.
    • If they choose to pay through bank/wire transfer, 2Checkout provides them with the required payment details so they can complete the transfer.
    • If they choose to pay through iDEAL, 2Checkout automatically takes them to the iDEAL page and they can complete the payment there.
    • If they choose to pay through Apple Pay, an Apple Pay payment sheet opens on top of the checkout page on their Apple device.
    • If they choose to pay through Alipay, they enter the billing information and then 2Checkout automatically takes them to the Alipay page where they can complete the payment.
  4. 2Checkout redirects them to the Finish page.

InLine Checkout supported features

Given the continuous developing nature of this project, InLine Checkout currently supports a limited feature subset of the current shopping cart.

Refer to the feature list below to confirm the availability of the features that you are interested in.

Feature Description / Supported
Billing currencies All the billing currencies currently enabled for your 2Checkout account.
Payment methods

Credit card-based payment methods, PayPal, Apple Pay, Alipay, bank/wire transfer, iDEAL, SEPA Direct Debit, Boleto/Pix for Brazil.

Credit cards with installments via PagBrasil are supported for Brazil.  

Credit cards with installments via Iyzico are supported for Turkey (only for MoR merchants).

Promotions

Supports:

  • Regular promotions
    • Coupon-based
    • Automatically applied
  • Special Price Promotions
Volume discounts Supported
Available cart languages 29 languages
Compact shopping card fields Supported
Checkout fields Supported via Add checkout fields
Auto-advance  Supported
Geolocation Supported
Manual renewal Supported via ConvertPlus
Automatic renewal Supported
Tax collection and VAT Information Exchange System Supported
Pricing options Supported
On-the-fly pricing for catalog products Supported
Cart Analytics Supported via Google Analytics and Google Tag Manager
Cross-selling campaigns in Checkout page Supported
Cross-selling campaigns in Thank you page Not supported
Affiliate network (merchant website links) Supported
Affiliate network (product links) Not supported
Single Sign-On Not supported
Upgrades Not supported
Trial products Supported
Bundles Not supported
Up-selling campaigns Not supported
Download Insurance Service Not supported
Gift orders Not supported
Custom cart variables Not supported

How to integrate InLine Checkout

1. Find out what Inline Checkout is, its availability, and how to integrate into your checkout flow. 

2. How to integrate Inline Checkout into your web store.

3. Read here a full list of Inline Checkout features that are currently supported. 

4. After integrating the Inline Checkout with your web store, you are ready to simplify the checkout experience and enable your customers to place orders only by confirming their payment information.

5. After you integrate the Inline Checkout JavaScript code in your website application, you get access to the library that allows you to add products, control billing and shipping details and start the checkout process

6. Learn how to subscribe/unsubscribe to Inline shopping cart events.

7. How to add a catalog product to the Inline Checkout.

8. How to add a dynamic product to the Inline Checkout.

9. How to set a custom price for catalog products in Inline Checkout.

10. How to set the billing details for the Inline Checkout.

11. How to set cart lock in the Inline Cart.

12. How to set a pricing option for catalog products.

13. How to set the return method in Inline Checkout

14. How to set test orders in Inline Cart.

15. How to set the shopping cart currency in the Inline Checkout.

16. How to set the shopping cart language in the Inline Cart.

17. How to set the customer reference in the Inline Checkout.

18. How to set the item external reference in the Inline Checkout.

19. How to set the order external reference in the Inline Cart.

20. How to set sale source in the Inline Cart.

21. How to set a pricing option for dynamic products in Inline Cart.

22.  How to set shipping details in Inline Cart.

23. How to test adding a product coupon to the Inline Checkout.

24. How to test adding product coupons to the Inline Checkout.

25. How to add a digital catalog product with regular auto-applied promotion and manually applied order promotion.

26. How to add a digital catalog product with auto-applied order promotion.

27. How to add a digital dynamic product with dynamic coupon.

28. How to add a physical dynamic product with dynamic shipping, dynamic taxes, and dynamic coupon.

Advanced customization

Overview

2Checkout supports advanced customization of myAccount enabling you to offer your customers a unified purchase and post-sale experience by tailoring myAccount to match your brand as well as the look and feel of your online store and shopping cart.

Benefits

  • Control the post-sale 2Checkout customer service platform for your shoppers, focusing it only on interactions they have with your company.
  • Build a personalized shopper portal experience for your customers complemented by branding and a design aligned with the look and feel of your website.
  • Offer a seamless transition from your store to the shopper portal, complete with capabilities enabling subscribers to manage subscriptions, upgrade and even update their information, including payment details, via a single account.
  • Hosting myAccount on a custom domain enables you not only to reduce potential shopper confusion since it's the same domain as you online store and the shopping cart, but also to focus it exclusively on the relationship with your shoppers, since only the products purchased from you are displayed.

Requirements

  1. Enterprise Edition Suite: Advanced myAccount customization is available for 2Checkout vendors running the Enterprise Edition Suite.
  2. Custom host: myAccount customization capabilities are available only in tandem with custom domains.

myAccount options

  • Default - The Default version of customer myAccount is available to all your customers unless you personalize the shopper portal.
  • Simple customization - the simplest way to personalize the design of myAccount and unify the shopping and post-sale experiences. Use the Simple customization options at your disposal to change the characteristics of standard myAccount user interface elements. Note: You need to host myAccount on a custom domain to have access to Simple customization capabilities.
  • Advanced customization - Control every aspect of your customers' myAccount post-sale experience. Full myAccount personalization is supported with the use of custom templates. Upload your own CSS (cascading style sheet) and JS (JavaScript) files and use them to offer your own version of myAccount to your customers. Note: You need to host myAccount on a custom domain to have access to Advanced customization capabilities.

Edit myAccount interface templates

To customize myAccount, access Interface templates under Setup, and select the myAccount tab. The Default template option is selected provided that no personalization was introduced, and you can select either:

  • Simple customization
  • Advanced customization

Simple customization

Provide a consistent, unified shopping experience by personalizing the design of myAccount. In addition to hosting myAccount on a custom domain, and focus it exclusively on the relationship with your shoppers, 2Checkout supports the customization of user interface elements, providing you with the tools to offer a consistent and unified experience.

You can customize the customer myAccount template selected by default by selecting the Custom option.

  • Branding - Custom myAccount designs will be branded experiences, featuring the same logo as the one uploaded in the 2Checkout Control Panel, under Account settings, in the Company Logo area.
  • Styles - you also control the color styles for myAccount text, icons, page title and subtitle, links (for new, hover and visited), for tabs (selected, hover) and tab text, as well as for the table header background and text. All you need is the hexadecimal codes for the new color you want to implement, but a default basic color selector is also available.

Taking advantage of the personalization options, you can redesign customer myAccount.

Advanced customization

Advanced customization is better suited if your myAccount personalization needs are more complex than what Simple customization can deliver. You can upload one or more .CSS files, and similarly use a single or multiple .JS files.

The last CSS or JS files you upload take precedence over previously uploaded items.  We recommend that you use only a single .CSS file and a single .JS file in order to optimize page load time.

Custom myAccount template requirements

Upload all files including CSS, JS but also graphical elements to 2Checkout's server via Media center. Unless uploaded to the 2Checkout servers, these files will not allow for an SSL connection to be established.

To build a new template from scratch click the Add template button.

Note: When first created, all new templates will use the default 2Checkout styles. Adding a new template without customizing it does not create a fully functional myAccount. For example, the menu is missing, since it's expected of you to add it during the redesign process.

Save a custom template

  1. Make sure that the checkbox next to the My Account option in the Add template area is checked.
  2. English is the default language for templates and cannot be unchecked. Select the additional languages in accordance with the location of the customers you'll target with custom myAccount shopper portals. Click on a language link to add/edit the template for that specific language. Check the boxes for the languages in which the template will be saved. Standalone copies of the template are available for the languages selected and you can manage them independently. By default, the English template will be used for all languages if no other localized templates are defined.
  3. Name your template to make it easily distinguishable from others.
  4. Upload External JavaScript and CSS files via Media center. 2Checkout Interface Templates use JavaScript and CSS external files to ensure a fast page loading time. Upload external JavaScript and CSS files via "Media Center." 2Checkout will automatically merge the files with the built-in interface files and serve them from a CDN (Content Delivery Network) for increased performance. For minor modifications, please use the inline editors below to overwrite specific lines in the existing .CSS or .JS files. Note: Changing these files is an advanced operation best handled by experienced programmers.
  5. Add your custom CSS and JS files. To upload the files, use the Media Center area of the Control Panel. Unless custom CSS and JS files are uploaded to a secure 2Checkout server a secure connection (SSL) cannot be established for your customers. Once uploaded, the CSS and JS files will be featured in the External JavaScript and CSS files area of custom myAccount templates. When added to a template, the custom .CSS and .JS files will override the default .CSS and .JS files used by 2Checkout for myAccount. Note: Any code inserted inline in the editors will overwrite the code inserted in the external .CSS and .JS files. Important: Make sure to delete from the inline editors any pieces of code that you customized using external .CSS and .JS files. For example, if you defined the full CSS through an external file, delete the code in the inline editor completely. However, in scenarios in which you customized only some portions of the template using the .CSS file, leave the necessary code in the inline editor.
  6. In addition, you can also edit the:
    • Doctype Declaration
    • Page Title
    • Page HTML Code

    Click Save per-editor after inline changes.

  7. Scroll down to the bottom of the page and click the Save button. The Save with comments button is designed to allow you to add observations to a custom template.

Save a custom template with inline changes only

Follow steps 1 through 4 as described above.

Use the Meta & CSS and JavaScript Code editors to enter the custom CSS and JS code for your personalized myAccount template. Click Save per-editor after inline changes.

This area is designed to style both myAccount and Customer Support.

When present, code in the inline editor will override both the custom .CSS and .JS files added to a template as well as the default .CSS and .JS files used by 2Checkout for myAccount.

Note: Any code inserted inline in the editors will overwrite the code inserted in the external .CSS and .JS files.

Steps 6 and 7 are the same as described in the section above.

Tags

Menu links

  • <--{MENU_LINK_MY_ACCOUNT}-->
  • <--{MENU_LINK_ORDER_LOOKUP}-->
  • <--{MENU_LINK_MY_PRODUCTS}-->
  • <--{MENU_LINK_USER_DATA}-->
  • <--{MENU_LINK_SUPPORT}-->

Extra functionality

  • <--{LANGUAGES}-->
  • <--{LOGOUT_LINK}-->

 

Content: <--{PAGECODE}--> (mandatory) It's designed to load the dynamic content of myAccount in accordance to the specific user.

Set a default template

Once you're done customizing or adding a personalized template, head over to Interface templates under Setup, click the myAccount tab and select advanced customization. Hit the Set default button for the custom template that you want your customers to see when they login into myAccount.

Preview a custom template

Navigate to Interface templates under Setup, click the myAccount tab and select advanced customization. Use the Click here link to preview the myAccount interface template. Note: In scenarios in which you're using localized custom templates, you'll be able to preview myAccount versions for each language.

Alternatively, click to edit the desired template, and in the General area on the next screen make sure the myAccount option is selected in the Preview in drop-down menu and click the Preview button.

Delete a default template

Navigate to Interface templates under Setup, click the myAccount tab and select Advanced customization. Click to edit the template you want to delete, scroll down to the bottom of the screen and hit the Delete button.

Generate links

Generate links for the myAccount home page, as well as for all other pages of the customer portal. These links can subsequently be used when building your personalized template.

Navigate to Interface templates under Setup, click the myAccount tab and select advanced customization. Open the drop-down Click here menu, and select Generate links. Alternatively, make your way to Generate links under Setup, and click on the myAccount Links tab.

In the next area, you'll be able to select myAccount pages and generate links for a specific template and language combination. Link testing functionality is also available.

Once generated, integrate these links into your custom myAccount template.

Generate links for the Customer Support page

Links to the Customer Support page are generated in a separate area of the Control Panel. Navigate to Generate links under Setup, and click on the Customer Support Links tab. This area enables you to select the template and the language for which Customer Support page links will be generated.

Templates available in this area include only those that impact:

  • Customer Support
  • Customer Support and the Shopping Cart
  • Customer Support, myAccount and the Shopping Cart

Template parameters

A unique parameter is associated by default to each custom template. You'll be able to notice that for custom templates, the links contain the MYACCOUNTSTYLE parameter, followed by an alphanumeric combination (string).

Use MYACCOUNTSTYLE to serve a different version of myAccount to customers, than the default template.

Let's assume the &MYACCOUNTSTYLE=12345 designates the default template and that &MYACCOUNTSTYLE=123456789 is associated to another custom template. If &MYACCOUNTSTYLE=123456789 is present in links, myAccount will be style according to the custom template associated to this parameter, even though it's not set as the default template.

When the MYACCOUNTSTYLE parameter is used, the custom template it's associated to will always be served, during the same browser session, regardless of whether the same identifier continues to be present in all other links or not.

In scenarios in which no MYACCOUNTSTYLE parameter is used at the start of a browser session, the default template associated to myAccount for your account will be used.

Customer Support

Custom templates defined for myAccount also impact the Customer Support area. When creating a personalized template for your customer hub, attempting to select the myAccount option will automatically also check the checkbox for the Customer Support page. Since the Customer Support page can be accessed from myAccount, it's preferable that it shares the same look and feel as the rest of your customer hub.

At the same time, access to Customer Support is also available via the Shopping cart. In scenarios in which shoppers make their way to the Customer Support page from the shopping cart, these areas will share the same template.

Products Objects

Two JavaScript products are available in myAccount:

  • 2CHECKOUT_PRODUCTS - in the My Products page
  • 2CHECKOUT_PRODUCT - in the View Product page

The two JS products contain all information visible to customers accessing myAccount, as well as some additional details.

2CHECKOUT_PRODUCTS

Array of 2CHECKOUT_PRODUCT objects

2CHECKOUT_PRODUCT

Object

ID

integer

NAME

string

PRICING_OPTIONS

string, // comma-delimited pricing option codes

QTY

integer

VERSION

string

TYPE

string, // e.g. REGULAR

PAYMENT_METHOD

string

CODES

Array of Objects

HAS_BACKUP_CD

boolean

DOWNLOAD_LINK

string

UPGRADE_LINK

string

WEBSITE

string

LICENSE

Object (optional)

ORDER

Object (optional)

 

 

CODES

Object

KEY

string

DESCRIPTION

string

 

 

LICENSE

Object (optional)

CODE

string

IS_BUNDLE

boolean

STATUS

string, // e.g. ACTIVE

ACTIVATION_DATE

string

EXPIRATION_DATE

string

UPGRADE_LINK

string

RENEW_LINK

string

NEXT_BILLING_DATE

string

NEXT_BILLING_AMOUNT

float

CURRENCY

string

CARD_NUMBER

string

IS_TRIAL

boolean

IS_DISABLED

boolean

BILLING_TYPE

string, // e.g. AUTOMATIC

TYPE

string // e.g. REGULAR

 

 

Order

Object (optional)

REFNO

string

IS_GIFT

boolean

DATE

string

STATUS

string, // e.g. COMPLETE

ORDERED_FROM

string

FAQ

1. How can shoppers access myAccount?

Your shoppers can access the customer myAccount through a secure, encrypted connection at https://secure.avangate.com/myaccount which supports a trusted shopping experience.

2. Do I need to create myAcount accounts for shoppers?

Shoppers are automatically registered into the customer myAccount service when they first place an order on your website if you're taking advantage of the 2Checkout platform. They need the email address used during the ordering process or the order number to receive all their login credentials, including a password. But at the same time, shoppers can easily login into their account using their Google, Yahoo! or AOL ID, without the need to know the password that was set for their myAccount.

3. What do I need to take advantage of custom myAccount?

Custom 2Checkout myAccount domains are available in tandem with personalized Ordering Hosts, providing your customers with accounts which share the same domain as the shopping cart used to buy your products.

Take advantage of custom myAccount domains to centralize and offer access only to information for the products that shoppers purchase from you, filtering out their actions in the 2Checkout network that are not related to your subscriptions/licenses.

2Checkout ConvertPlus

Overview

ConvertPlus simplifies the process of collecting payments from shoppers using major credit/debit cards, PayPal, Apple Pay, Alipay, Boleto/Pix, bank/wire transfer, iDEAL, and SEPA Direct Debit. We are building and adding new features continually.

Recommended resources

Availability

ConvertPlus is available to all 2Checkout accounts. 

To enable the ConvertPlus on your merchant account, contact the 2Checkout Support Team.

Requirements

2Checkout merchants who already have the new shopping cart enabled can generate buy links for the optimized purchase flow from the 2Checkout Control Panel.

Generate buy links

Follow the steps below to generate buy links for your products using the new shopping cart.

  1. Login to the 2Checkout Merchant Control Panel.
  2. Go to Setup -> Generate links.
  3. Click the ConvertPlus tab in the Checkout Links area.
  4. Select the products you want to generate checkout links for. In case you are using dynamic products, read the instructions from this article.
  5. Choose the product quantity.
  6. Click on Generate link.
  7. Copy the generated link and add it to your website.

Test buy-links

You can test the link before adding it to your website in multiple ways:

  • Copy the link and paste it into your browser’s address bar.
  • Click on Test link to open it in a new browser tab.
  • Scan the QR code with a smartphone app to view the checkout page on a mobile device.

Supported payment methods

2Checkout ConvertPlus supports the following payment methods:

  • Credit/debit card
    • Visa
    • Visa Electron
    • MasterCard
    • Maestro
    • American Express
    • JCB
    • Discover
    • UnionPay
  • PayPal
  • PayPal Express
  • Bank/Wire transfers
  • SEPA Direct Debit
  • iDEAL
  • Boleto/Pix
  • Credit cards with installments
  • Apple Pay
  • Alipay

ConvertPlus is optimized to display popular payment methods based on shopper location. This makes it easier for customers to complete a purchase using their favorite payment method, which will result in a higher conversion rate for you.

Purchase flow

The checkout experience is ensured by a one-page checkout flow that enables shoppers to quickly finalize their purchases without spending too much time in the shopping cart.

  1. Shoppers add the products to their cart.
  2. Once they reach the shopping cart they can select product options/plans and add a coupon code (if applicable).
  3. They select the payment method.
    • If they choose to pay by card, they enter the billing and card information and finish the payment.
    • If they choose to pay through PayPal, 2Checkout automatically takes them to PayPal’s login page where they have to agree and continue with the payment. Afterwards, the shoppers will be redirected to the 2Checkout shopping cart to complete the purchase.
    • If they choose to pay through bank/wire transfer, 2Checkout provides them with the required payment details so they can complete the transfer.
    • If they choose to pay through iDEAL, 2Checkout automatically takes them to the iDEAL page and they can complete the payment there.
    • If they choose to pay through Apple Pay, an Apple Pay payment sheet opens on top of the checkout page on their Apple device.
    • If they choose to pay through Alipay, they enter the billing information and then 2Checkout automatically takes them to the Alipay page where they can complete the payment.
  4. 2Checkout redirects them to the Finish page.

ConvertPlus Cart Editor

The Cart Editor module allows you to perform simple customizations to ConvertPlus cart themes, to make the shopper payment experience unique.

Click here to learn how to use the ConvertPlus Cart Editor.

Supported features

Given the continuously developing nature of this project, the new 2Checkout shopping cart currently supports a limited feature subset of the current shopping cart.

Refer to the feature list below to confirm the availability of the features that you are interested in.

Feature Supported/Not supported
3-D Secure Ordering Supported
Available cart languages 29 languages
Billing currencies All the billing currencies that are currently enabled for your 2Checkout account
Payment methods Credit card-based payment methods, Orders with installments, PayPal, bank/wire transfer, iDEAL, SEPA Direct Debit, Boleto/PIx, Apple Pay, Alipay
Promotions

Supports regular and special price promotions:

  • Coupon based
  • Automatically applied
Order promotions Supported
Compact shopping card fields Supported
Automatic renewal Supported
Geolocation Supported
Pricing options Supported
Pricing configuration Supported
Volume discounts Supported
Dynamic ordering Supported. ConvertPlus allows you to receive orders without having catalog products defined, by passing the product information through the buy link parameters.
URL parameters

Supports product code and quantity URLs.

  • Example: &prod=code1;code2&qty=5;2
Tax collection and VAT Information Exchange System Supported
Template customization Supported via Cart Editor
Manual renewal Supported (only for catalog products)
Additional checkout fields Supported via Additional checkout fields
On-the-fly pricing for catalog products Supported via Override configured product prices
Physical product & Shipping Supported
Tax validation display Supported
Testing options Supported
Lead management Supported. Unfinished payments and cart abandons.
Dunning Supported
Checkout flow with/without review Supported
One-step/multi-step inline Supported
Express flow Supported
Cart analytics Supported. Google Analytics and Google Tag Manager.
Simple customization Supported
Advanced customization (via Professional Services) Supported
Cross-selling campaigns in Checkout page Supported
Cross-selling campaigns in Thank you page Not supported
Affiliate network (merchant website links) Supported
Affiliate network (product links) Not supported
Tracking script Not supported
Purchase orders  Not supported
Trial products Supported
Bundles Not supported
Upgrades Not supported
Up-selling campaigns Not supported
Download Insurance Service Not supported
Gift orders Not supported
Custom cart variables Not supported

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