Overview

2Checkout is your reliable payment partner for receiving payments from customers worldwide. Depending on your business model, you can opt-in for selling electronic or physical products.

Catalog physical products

Use the Control Panel to manage your catalog of physical products, with advanced control over attributes such as: handling fee and product weight.

Create shipping methods that will be displayed to your customers in cart, based on product weight, customer location and other filters that you control. You can later confirm the shipment of your tangible products towards your customers.

Dynamic physical products

2Checkout enables you to receive orders placed with dynamic product information, even if you are selling tangible products.

Read this article to learn more about orders placed with dynamic product information.

Overview

A cookie is a small text file that a website places on a user’s computer (including smartphones, tablets, or other connected devices) to store information about the user’s activity. Throughout the world, regulating entities see cookies as a “persistent identifier”, thus falling under the rules applied to protect Internet users' personal information.

Regulatory entities:

• For California – CCPA
• For EU – GDPR, ePrivacy Directive, Cookies and other tracking technologies
• National regulations (per country) on privacy and protection of personal information

Availability

All shoppers have access to the myAccount customer portal. Consequently, all of them will be seeing the cookie consent displayed (in one form or another, depending on where they are located when they access the portal. See more details below).

Out-of-the-box enhancement by 2Checkout

For shoppers in California (USA) and the European Union, 2Checkout uses three types of cookies:

• Strictly necessary (mandatory) - These cookies help protect shoppers' data available during and after logging into their 2Checkout myAccount and cannot be disabled.
• Preference (optional) - These cookies are used to remember customers’ choices during navigation through their 2Checkout myAccount, such as pagination selection or list types.
• Statistics (optional) - These cookies help 2Checkout understand the shoppers' interaction with their customer myAccount, so that our system can identify issues and continuously improve the overall experience shoppers have. Data is collected and reported anonymously.

2Checkout collects consent upon the shoppers' 1st access in myAccount through a footer ribbon where the user can:

• Accept all cookies - This will check all the above 3 types of cookies
• Customize settings/Do not sell my info (for California users only) - This will enable the user to check any cookies other than the mandatory ones
• Access the 2Checkout cookie policy.

Once the shopper performs an action on the footer ribbon, this will not be shown during any other subsequent accessing of the portal (for a one-year period). A link to “Cookie settings” will be available (bottom right corner), where the user will be able to change options for the optional types of cookies at any time. After one year, the footer ribbon will, once again, be displayed, to collect consent for the placed cookies.

By clicking on the Customize settings button, the user will be prompted with a separate window where they can choose their preferred settings.

The footer ribbon displayed for California shoppers will display a variation of the text on the customize settings button, as shown below.

For shoppers from the rest of the world (ROW), including the US outside California, 2Checkout uses three types of cookies:

• Strictly necessary - These cookies help protect customers' data available during and after login into their myAccount platform and cannot be disabled.
• Preference - These cookies are used to remember customers’ choices during navigation through myAccount, such as pagination selection or list types.
• Statistics - These cookies help 2Checkout understand the interaction of the users with their myAccount platform so our system can identify issues and continuously improve the overall experience they have. Data is collected and reported anonymously.

2Checkout collects consent upon 1st access in myAccount that all cookies are enabled (they cannot be unchecked) through the footer ribbon where the user can:

• Click OK - This will mark the fact that the user acknowledged the cookies set-up.
• Access the 2Checkout cookie policy.

Once the shopper performs an action on the footer ribbon, this will not be shown during any other subsequent accessing of the portal (for a one-year period). A link to “Cookie settings” will be available (bottom right corner), where the user will not be able to change options for the optional types of cookies.

For US users with unidentified state locations, 2Checkout will display the rules applied for California users. For ROW users with unidentified state location 2Checkout will display the rules applied for EU users.

Customization options

Depending on the template you already use for your 2Checkout myAccount platform, the footer ribbon can be adapted to visually align with your website's layout. But customization needs to keep mandatory elements in place, to make sure compliance requirements are met:

• The user needs to be prompted to actively provide consent for the cookie setup.
• The link to the “cookies settings” needs to always be available inside the customer portal – for the user to view/change options.
• The link to the Cookie policy available on 2Checkout website should always be displayed inside the ribbon + cookie management overlay.

If customization is needed for your company, you can reach out to your assigned account manager within 2Checkout or write an email to support@2checkout.com to assist you in the process.

Use the variables in the list below to customize the Subscription price changed 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.

Overview

Use this section to handle the renewal of your subscriptions.

You can retrieve information regarding the renewal status of a subscription, including the manual renewal link that a customer needs to access in order to renew.

Enable or disable the recurring billing for a subscription using the API methods displayed below.

Overview

Use the variables in the list below to customize the Automatic 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.

Before you start using the 2Checkout API, check your PCI DSS compliance status. Find out more details about what PCI compliance means and what you should do to be PCI compliant here.  

Overview

Use this section to handle the renewal of your subscriptions.

Overview

Retrieve information about a subscription.

Parameters

Overview

Use webhooks to be notified automatically and in real-time about events in your 2Checkout account.

Availability

IPN notifications are available to all 2Checkout account types.

What is IPN?

Instant Payment Notification (IPN) works as a message service generating automatic order/transaction notifications for your 2Checkout account. Use the notifications to process order data into your own management systems by synchronizing it with 2Checkout account events.

Webhook asynchronicity

2Checkout’s webhooks (IPN and LCN) operate asynchronously.

How can I use IPN?

Use IPN to automate back-end functions, including but not limited to:

• Creating end-user accounts
• Providing access to acquired services
• Fulfilling purchases
• Tracking orders and customers
• Engaging customers

How does IPN work?

1. Create one or multiple IPN listener pages on your website. 2Checkout sends IPNs to publicly accessible servers.
2. Configure the IPN settings of your 2Checkout account to point to the URLs of your default/preferred listener pages. Our system performs a GET request against the URL you fill in and expects an HTTP 200 code as a response. Make sure that your URL can be queried via a GET request from our webserver  IPs.
3. Set up multiple URLs if you require more listener pages, such as in testing scenarios in which you don’t want to use your default IPN listener. 
4. 2Checkout sends order notifications to the endpoints you defined when shoppers acquire products/services from your online store. 2Checkout packages the payment information and sends it using secure (HTTPS) POST, according to your IPN settings.
5. 2Checkout sends the IPN parameters according to your setup from IPN Settings. To include additional information in the notifications, enable new parameters in the IPN settings page. Learn more about IPN parameters here.
6. 2Checkout uses an HMAC_SHA signature to validate the HTTPS POST. Calculate the signature using data sent and your 2Checkout account’s secret key, following the instructions included in this article.
7. Your custom IPN listener scripts consume the notifications and process the info received.
8. Configure your IPN listeners to output a read receipt confirmation on the listener page after receiving a valid IPN message. Guidance on how to generate the confirmation can be found here.
9. In the absence of a confirmation from one of your IPN listeners, 2Checkout continues to send notifications to that endpoint, according to the failure retry process, until you provide a valid response.
10. In the eventuality that 2Checkout fails to send IPNs or doesn’t receive a confirmation from your IPN listener, it displays an error in your Control Panel, on the Dashboard.

Set up the default IPN URL

1. Log into your 2Checkout account.
2. Navigate to Dashboard → Integrations → Webhooks and API.
3. Click on the IPN Settings tab.

4. Click on the Edit button to edit an existing URL corresponding to your default IPN listener or click on the Add URL button to add a URL corresponding to your default IPN listener in the IPN URL field.

      All merchants are strongly advised to migrate to SHA2/SHA3. We will stop supporting the MD5 algorithm in our platform on the 15th of August, 2024. For more details check the Migration guide documentation.
5. Check the Allow concurrent requests (faster notifications) option. If checked, 2Checkout sends multiple notifications concurrently to your IPN URL. Note: This may cause concurrency problems, but will greatly improve the notification time.
6. Save your settings.
7. 2Checkout checks the validity of the URLs in terms of access to ensure that notifications reach your IPN listener without any issues.

Set up multiple IPN URLs

You can set up multiple endpoints for your IPN notifications, for scenarios in which you have multiple Internal Systems that require to receive this information. You can set up eight (8) URLs for your notifications.

Navigate to IPN settings under Integrations → Webhooks and API, in your Merchant Control Panel Dashboard. Select the IPN Settings tab and click on the Add IPN URL button to create an additional URL configuration for your notifications.

To find out more about the NOTIFICATION_URL functionality, read more here.

Debug IPN

To view or debug IPN notifications during the integration phase, place TEST orders.

Alternatively, search for specific orders in the "Orders & Reports" area. When you access the order details page you get the option to resend notifications. You can also see how many IPN notifications have been sent so far for an order. Opt to reissue the IPN for debugging and 2Checkout re-generates and re-sends the IPN, but also displays a copy of the content sent in the control panel.

Secure your IPN script

For security reasons, 2Checkout recommends that you restrict access to the IPN script.

Overview

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

                                           Retrieve product group                                                  Retrieve product groups

Product group object