For the complete documentation index, see llms.txt. This page is also available as Markdown.

Upgrade to 2Checkout API 6.0

To get a frictionless experience, migrate your 2Checkout API implementation to our newest version - API 6.0. This document features deprecations, updates, and enhancements, guiding how to upgrade your implementation to the latest version of the 2Checkout API.

New authentication flow

To use the latest 2Checkout API version, you need to update your authentication process. The parameters included in the authentication flow are displayed below.

Parameter
Type / Description

merchantCode

Required (string) Your merchant identification code. Can be found in your Admin Area, in the System Setting section.

date

Required (string) GMT ISO Date format (e.g. 2010-01-01 12:13:14)

hash

Required (object) Calculated HMAC_SHA signature based on merchantCode and date, using your secret key. Your secret key can be found in your System settings area.

algo

Required (string) Hashing algorithms.

Accepted values: sha256 / sha3-256

API protocols

The latest 2Checkout version (API 6.0) is available via three API protocols: JSON-RPC, SOAP, and REST. Check the authentication method for each of them below.

API Protocol
Authentication

REST

JSON-RPC

SOAP

2Checkout API methods status

2Checkout legacy method
Status
2Checkout new API method

detail_sale

Updated. Use:

list_sales

Updated. Use:

refund_invoice

Updated. Use:

refund_lineitem

Updated. Use:

stop_lineitem_recurring

Updated. Use:

reauth

Deprecated

N/A

mark_shipped

Deprecated

N/A

list_products

Updated. Use:

detail_product

Updated. Use:

create_product

Updated. Use:

update_product

Updated. Use:

delete_product

Deprecated

N/A

list_options

Updated. Use:

detail_option

Updated. Use:

create_option

Updated. Use:

update_option

Updated. Use:

delete_option

Deprecated

N/A

list_coupons

Updated, but for promotions. Use:

detail_coupon

Updated, but for promotions. Use:

update_coupon

Updated. Use:

delete_coupon

Updated. Use:

detail_company_info

Deprecated

N/A

detail_contact_info

Deprecated

N/A

detail_pending_payment

Updated. Use:

list_payments

Deprecated

N/A

Last updated

Was this helpful?