Skip to main content
knowledgecenter.2checkout.com

Start using the 2Checkout API

Start using the 2Checkout API
You can use the 2Checkout API to build apps that connect to the 2Checkout system, place and manage orders, manage subscriptions and customers, create, update and extract product catalog and pricing information for your account, manage partner accounts, integrate with 2Checkout to automate you backend operations.

Before you start using the 2Checkout API, make sure you are PCI compliant. Find out more details about what PCI compliance means and what you should do to be PCI compliant here.

Overview

Use the 2Checkout API to:

  • Build apps that connect to the 2Checkout system
  • Place and manage orders
  • Manage subscriptions and customers
  • Create, update and extract product catalog and pricing information for your account
  • Manage partner accounts
  • Integrate with 2Checkout to automate you backend operations

Connecting to the 2Checkout API

To connect to the API, you need your merchant code, secret key, and secret word. These unique codes are automatically generated for your account, and you can retrieve them from your Control Panel Dashboard → Integrations → Webhooks and API. Copy the merchant code (found in the API section) and the Instant Notification Service (INS) secret word found in the Secret word area.

secret word.png

Architecture overview

For more details on how the 2Checkout API works, here's an overview based on the architecture used:

API Authentication

Use the merchant code and secret key to authenticate with the API. Click the links below to learn how to authenticate:

Read the API documentation

Once you've authenticated with the API, you can start configuring your environment for your specific usage scenario.

Our API documentation should help you get things done as fast as possible.

3rd party applications

You can build apps that connect to the 2Checkout system to expand existing functionalities and gain more insight into your activity while optimizing your sales. Click here to read the documentation for detailed guidance on how to build your own apps.

API libraries

Use the API client-side encryption library to encrypt sensitive payment data before sending it to 2Checkout.

2Checkout GitHub

Feel free to visit our GitHub repository to download and contribute to our code samples. We also encourage you to submit your own projects related to the 2Checkout API.

Webhooks

  • 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.
  • License Change Notification (LCN) works as a message service generating automatic subscription notifications for your 2Checkout account.

     

    • Was this article helpful?