APIs, step-by-step guides, and tools to help you integrate payments, manage subscriptions, and operate globally with confidence.
| Cover image | ||||||
|---|---|---|---|---|---|---|
Hosted checkout | Get started in minutes with our most popular hosted solutions. | ConvertPlus | InLine client | Create a payment link | /spaces/deHPh87488cW76Md0m4D | /files/XQB8xC6pBElyONiuDpio |
API Reference | Explore the 2Checkout APIs and choose the solution that works bets for you. Browse, test, and implement APIs. | REST API | Webhooks | 2Pay.js | /spaces/9Z7UgWMSxxDpoeZtZX1w | /files/M9r2pfZggAcilPK7xOde |
| Cover image | Cover image (dark) | ||||
|---|---|---|---|---|---|
Global payments | Build online revenue without payment processing headaches, no matter where your business is or where your clients are.
| Read more | /spaces/deHPh87488cW76Md0m4D | /files/ZY7kBgd8VN0Ec6tP9xhG | /files/ZVPrBX8yVkgAD8RXfkke |
Subscription Billing | The subscription solution helps you manage subscriptions and customers, handle invoices and recurring billing, all to improve revenue. | Read more | /spaces/deHPh87488cW76Md0m4D | /files/M2DIIZmvPN9y4crUASAD | |
Tax & Financial Services | 2Checkout takes the complexity out of doing business in today's global market. | Read more | /spaces/9Z7UgWMSxxDpoeZtZX1w | /files/ua6hAWk54rKyGEQOVf9t |
| Cover image | ||||
|---|---|---|---|---|
Reporting & Analytics | Get instant insights into sales and trends as well as customer health metrics, overall or at the business unit level, all from your commerce dashboard.
| Read more | /spaces/deHPh87488cW76Md0m4D | /files/7zlSUYum6wNHjcq5DZLi |
Fraud Prevention | When selling internationally, managing payment fraud and complying with international regulations are major issues. We take care of both, so you can focus on growing your business. | Read more | /spaces/deHPh87488cW76Md0m4D | /files/ZOzXiQ0XlOSEX0PGPjDB |
Marketing Tools | Whether you need a solution for promotions, upselling or cross-selling, 2Checkout has got you covered with a comprehensive set of marketing tools.
| Read more | /spaces/9Z7UgWMSxxDpoeZtZX1w | /files/KuxcX0qT7ks9DnwIv9VM |
| Cover image | ||||
|---|---|---|---|---|
Affiliate Network | Leverage 2Checkout's Affiliate network and boost your revenue.
| Read more | /spaces/deHPh87488cW76Md0m4D | /files/qzEXaHnwolfN5H4i2iwO |
Partner sales | 2Checkout offers multiple tools to manage your relationships with resellers. | Read more | /spaces/deHPh87488cW76Md0m4D | /files/YtDjUAUQbwr2guojpF4v |
Contact our support teams or log a Jira ticket in just a few steps.
| Cover image | ||||
|---|---|---|---|---|
:circle-question: | 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. | Contact support | /files/rB2SXtrGCbNltDnb0J9e |
:user-message: | Not yet a 2Checkout customer? | 2Checkout can help take your business global. We can set you up with the right payment solution for your business. Get in touch with our sales reps, and our team of experts will happily discuss your needs.
| Talk to Sales | /files/k162tdpoAdbe4Kzftw4d |
API Integration | Full custom control Requires developer | 2Checkout API |
No-Code Checkout | Hosted payment page No coding needed | Shopping carts |
Plugins & Links | CMS / platform ready Install & configure |
| Field | Value |
|---|---|
| ACS URLs | https://secure.2checkout.com/cpanel/saml-login |
| Entity ID | https://secure.2checkout.com/cpanel/saml-login |
| Field | Value |
|---|---|
| Target Application URL | https://secure.2checkout.com/cpanel/saml-login |
| Field | Value |
|---|---|
| Identifier (Entity ID) | https://secure.2checkout.com/cpanel/saml-login |
| Reply URL (Assertion Consumer Service URL) | https://secure.2checkout.com/cpanel/saml-login |
| Sign on URL | Leave blank (Optional) |
| Relay State | https://secure.2checkout.com/cpanel/saml-login |
| Logout URL | Leave blank (Optional) |
| Field | Value |
|---|---|
| Single sign-on URL | https://secure.2checkout.com/cpanel/saml-login |
| Audience URI (SP Entity ID) | https://secure.2checkout.com/cpanel/saml-login |
| Name ID format | EmailAddress |
| Application username |
Only accounts that have the Retention tools package enabled can see this privilege displayed.
Allows users to view and manage retention campaigns, and provides access to Enrollment and Churn prevention reports.
| ### Orders & Reports | Privilege name | Description | | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Accounting | Controls access to **Accounting**, **Vendor 2 Vendor,** and **Purchase Order** settings. | | View and search eStore order data | Controls access to **Order Search.** | | Executive Reports |Controls access to:
Recommended:
Yearly: SAQ-A
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
|
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: Attestation of Compliance ("AOC") by Qualified Security Assessor ("QSA")
Quarterly: ASV Scan
Recommended:
Yearly: SAQ-A
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: Attestation of Compliance ("AOC") by Qualified Security Assessor ("QSA")
Quarterly: ASV Scan
Recommended:
Yearly: SAQ-A
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: Attestation of Compliance ("AOC") by Qualified Security Assessor ("QSA")
Quarterly: ASV Scan
Required:
Yearly: SAQ-D
Quarterly: ASV Scan
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: SAQ-A
Quarterly: ASV\* Scan
Required:
Yearly: Attestation of Compliance ("AOC") by Qualified Security Assessor ("QSA")
Quarterly: ASV Scan
This form can be filled in only by the master account that belongs to the account holder.
Receive payments from 2Checkout accounts with no 2Checkout transfer fees. Additionally, Payoneer provides direct ATM access to the funds transferred from the 2Checkout account onto the Payoneer account.
You can register for a Payoneer card from your Merchant Control Panel, by navigating to Settings - Payout details and clicking on the 2Checkout MasterCard powered by Payoneer tab. You will then be directed to Payoneer's website to complete your sign-up.
| 1 business day |no 2Checkout fee (might incur fees from Payoneer, for more details check your Payoneer agreement)
Note: India does not support pre-paid Payoneer.
| ### Payout currencies 2Checkout supports three currencies for payouts for all merchants. Only ***one*** currency can be selected from the **Financial details** section of the Control Panel to receive payouts from 2Checkout.\* (See the **Payout destination** section below.) To change your payout currency, follow the steps described in [Payout settings](https://verifone.cloud/docs/2checkout/Onboarding/). The 2Checkout Financial Operations will review the payout information update request within 2 days of the submission date. Expand table | Account Type | Payout method | Currency | | -------------------------------------------------------- | ----------------------------- | -------- | |
2Sell
|
Wire
| USD | | | Wire | GBP | | | Wire | EUR | | | PayPal | USD | | | Pre-Paid 2Checkout MasterCard | USD | |
2Subscribe
|
Wire
| USD | | | Wire | GBP | | | Wire | EUR | | | PayPal | USD | | | Pre-paid 2Checkout MasterCard | USD | |
2Monetize
|
Wire
| USD | | | Wire | GBP | | | Wire | EUR | || PayPal | USD | | | PayPal | EUR | | | Pre-paid 2Checkout MasterCard | USD | ### Payout Destination You can select one payment destination according to the payment details you set in the platform and that were accepted by 2Checkout. Additional payment destination is based on request and subject to additional charges. ## Deposits You may have noticed that a percentage of your total sales is held in your account at all times. This amount/deposit may vary for each merchant and corresponds to a set percentage of sales that has been designated to stay in your 2Checkout merchant account on a rolling 90-day basis. ### How Are deposit Rates Determined? Deposit rates are set in proportion to the level of risk of each merchant. While risk can never be entirely eliminated, it can be managed. Merchants who take an active role in preventing fraudulent claims often receive a lower deposit rate as a result. Managing risk can be inherently more difficult in some industries. For example, intangible goods are much riskier than tangible goods from a fraud perspective, simply due to their nature. It’s much easier to prove that a tangible good was shipped to a customer than to prove that a service was provided or an intangible good was delivered; intangible goods merchants receive many more fraudulent claims because of this reality. ### Why Do deposit levels Rise? Deposit levels can be raised for several reasons: sudden increases in chargebacks or refunds are the leading cause of raised deposit levels. If your deposit level has been raised, the change isn’t necessarily permanent. Our team continuously reviews accounts to ensure each merchant receives an appropriate deposit level and risk assessment. Additionally, merchants may request that their deposit levels be revisited if they’ve updated their business practices. ### Keep Your deposit Level Low We want our merchants to have access to the largest portion of their funds possible at all times. Here are a few tips to keep your deposit rate as low as possible: #### Prevent Chargebacks [Chargebacks](https://verifone.cloud/docs/2checkout/Support-Center/Best_practices/How_to_increase_your_chances_of_winning_a_chargeback/) are the biggest reason why deposit levels are increased. Try to [keep your chargeback rate under 0.5%](https://verifone.cloud/docs/2checkout/Support-Center/Best_practices/How_to_lower_chargeback_rates/). You can achieve this by: * Keeping an eye out for users who are subscribed to your services but haven’t utilized them in two or more billing cycles. Discontinued use could be an indicator that a buyer has forgotten about his or her purchase, which could result in a chargeback. * Reviewing your sales frequently for consistency and fraud identification. Look at the number of purchases, the volume of purchases over a set time period, credit cards used, address verification system (AVS), card verification value (CVV), and buyer information like name, email address, billing and shipping addresses, and IP address to identify inconsistencies that may point to fraud. * Making sure your website is complete and accurate. Describe the product(s) customers will receive, delivery processes, and expected delivery time frame in great detail to avoid surprises. Also, be sure that your refund and privacy policies are conspicuously displayed on your website and up-to-date. If you have the appropriate resources, it’s best to display product information in your customers’ preferred language(s) to prevent surprises and subsequent chargebacks. * Be proactive with customer issues. This includes all of the following: * Make sure your contact information is up to date and allows customers to easily initiate communications through multiple channels (phone, live chat, email, etc). * Promptly respond to all inquiries. * Provide tracking information for tangible goods. * Remove or clearly identify any back-ordered products on your website. * Cancel duplicate transactions immediately upon discovery. * Cancel orders that were not fulfilled or were requested to be canceled. * Offer partial refunds to unhappy customers. * When it comes to chargeback prevention, reviewing your orders for fraudulent activity or unhappy customers applies to both new sales and existing sales. Review your older sales to see if there are suspicious transactions or upset buyers with orders that require a partial or full refund in order to avoid chargebacks. #### Prevent Fraud Fraudulent orders go hand in hand with chargebacks. Take an active role in mitigating your risk of fraud by following these guidelines: * Review your orders to make sure information is legitimate. For instance, make sure phone numbers are valid and that they match the states and/or countries listed on the billing information. Also, review the IP location to ensure it matches the billing address for each order. * If you see that information does not match or is not valid, verify the order via phone to ensure its authenticity. If you are not able to do this, cancel the order or contact [2Checkout](https://www.2checkout.com/contact/contact-us-merchants/) for assistance with your fraud review. ## FAQs
In case you forgot your account password, use the password recovery functionality and a link for generating a new password will be sent to the e-mail address you use to log in to the Merchant Control Panel.
If you wish to disable the two-factor authentication for a user, uncheck the Two-factor authentication by email option and save the changes.
Supports regular and special price promotions:
Supported
ConvertPlus allows you to receive orders without having catalog products defined, by passing the product information through the buy link parameters.
| | [URL parameters](/shopping-carts/convertplus/convertplus-url-parameters) |Supports product code and quantity URLs.
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 | # ConvertPlus URL parameters ## Overview Use 2Checkout ConvertPlus to provide your customers with a swift and safe payment experience. Depending on your desired workflow, you can either create ordering interface links using our dedicated interface ([C](https://secure.avangate.com/cpanel/integration.php)[onvertPlus](https://secure.avangate.com/cpanel/integration.php?flow=ConvertPlus)) or generate the parameters dynamically, in your own system. 2Checkout enables you to use ConvertPlus with both catalog products and with products generated dynamically via buy-link parameters. {% hint style="info" icon="lightbulb" %} #### ConvertPlus is a full-stack solution that enables you to increase conversion rates with faster loading time and optimized flows. Download this solution brief to learn more! Read more {% endhint %} ## Availability Eligible 2Checkout accounts. Contact 2Checkout to inquire about ConvertPlus. ## Requirements To use **ConvertPlus** dynamic ordering, pass the **dynamic** parameter with **TRUE** or **1** value. When creating orders with catalog products, the **prod** parameter should contain the **product code** of your catalog item. For dynamic ordering, the **prod** parameter should contain the **name** of your dynamic product. ## How to create dynamic ConvertPlus buy-links 1. Start from the **base** ConvertPlus buy-link: ``` https://secure.2checkout.com/checkout/buy/? ``` 2. Add your merchant code to the buy-link, so that 2Checkout links the sale to your account. Your merchant code can be found in your Control Panel, in the [Account Information area](https://secure.2checkout.com/cpanel/account.php). Example: merchant=2COLRNC. 3. Set the **dynamic** parameter to **TRUE** or **1**. 4. Add product information such as **product type**, **name**, **price,** and **quantity**. 5. Include additional product information, such as recurring options or customer redirect URL. ### Sample ConvertPlus buy-link for dynamic product information The following buy-link reproduces a dynamic ordering experience: ``` https://secure.2checkout.com/checkout/buy/?merchant=2COLRNC&dynamic=1&prod=2CheckoutSubscription&type=PRODUCT&qty=1&price=10&test=1 ``` ## Buy-link parameters When you generate a checkout link, 2Checkout automatically includes some of the parameters in the list below in the URL, depending on a number of variables, such as the products, discounts, currency, and more. You can use these query parameters to generate checkout links in your own system, without having to rely on the functionality in your account.| Parameter | Required / Optional | Description |
|---|---|---|
| Billing information | Use these parameters to control the billing information displayed in the shopping cart. By adding these parameters in the buy-link, you can pre-fill the customer information and minimize the customer effort in the ordering process. | |
| Optional | Send customer email | |
| name | Optional | Send full customer name. Ex: "John Steward Doe". |
| phone | Optional | Send customer phone number |
| country | Optional | Send customer country code. Two-digits code. Ex: "UK". |
| state | Optional | Send customer state code. Two-digits code. Ex: "CA". |
| city | Optional | Send customer city. |
| address | Optional | Send customer address |
| address2 | Optional | Send customer additional address information |
| zip | Optional | Send customer zip code |
| company-name | Optional | Send Company name. When sending the Company name, the Company checkout flow will be triggered. Otherwise, the default checkout flow for ConvertPlus is the individual flow. |
| fiscal-code | Optional | Send company Fiscal code. When sending the Fiscal code, the Company checkout flow will be triggered only if also another company flow relevant parameter will be also sent (Company name and/or Tax office). Otherwise, the default checkout flow for ConvertPlus is the individual flow. |
| tax-office | Optional | Send company Tax office. When sending the Tax office, the Company checkout flow will be triggered. Otherwise, the default checkout flow for ConvertPlus is the individual flow. |
| Delivery information | Use these parameters to control the billing information displayed in the shopping cart. By adding this parameters in the buy-link, you can pre-fill the customer information and minimize the customer effort in the ordering process. | |
| ship-name | Optional | Send customer delivery name. Ex: "John Steward Doe". |
| ship-country | Optional | Send customer delivery country code. Two-digits code. Ex: "UK". |
| ship-state | Optional | Send customer delivery state code. Two-digits code. Ex: "CA". |
| ship-address | Optional | Send customer delivery address |
| ship-address2 | Optional | Send customer additional delivery address information |
| ship-zip | Optional | Send customer delivery zip code |
| Product information | Use the parameters to create products with dynamic information, skipping the need of handling a product catalog in your 2Checkout Control Panel | |
| dynamic | Required for dynamic products | Boolean. Set TRUE for dynamic products. |
| prod | For catalog products | Product codes added to checkout, separated by a semicolon. Do not use spaces or blanks. Example: prod=46CC15F39;7488E17CC0. Product codes are assigned by you at the moment you are adding new products. In the Control Panel, click to edit a product, and select the Information tab. The Product code of the item you're editing is available at the top of the General area under Information. Warning: Changing a product code already used in active buy-links will completely break the checkout flow for those links. If you change a product code, make sure all your buy-links for that product are replaced with new links generated with your current product code. For buy-links with on-the-fly and trial pricing, this parameter is mandatory and has to be included in the signature. |
| prod | For dynamic products | Set the dynamic parameter TRUE to use dynamic products in the ordering process. When using dynamic products, the prod parameter contains as value the name of the dynamic product. For multiple products, send them separated by a semicolon. Example: name1;name2;name3. |
| item-ext-ref | For dynamic products | Set product identifier for your dynamic products. When included, the parameter needs to be signed. |
| type | Required for dynamic products | The type of the dynamic product. Possible values:
For multiple dynamic items, send the values separated by a semicolon. |
| qty | Required | The number of units (quantity) for each product in checkout, separated by a semicolon ;. Do not use spaces or blanks. Example: qty=2;1. qty works in conjunction with prod, based on their respective order. The first value of the qty parameter controls the number of units for the products whose identifier is in the first position of the prod parameter. Example: https://secure.2checkout.com/checkou...rchant=2COLNC&prod=6FD08E61B5;E2932D0DE2&qty=4;3
|
| price | Required for catalog products with on-the-fly pricing | For catalog products with on-the-fly pricing, custom price and currency must be included in the buy-link. For multiple products with on-the-fly pricing, send the values separated by a semicolon. Example: price=currency1:val1;currency2:val2;currency3:val3. For buy-links with multiple prices per each product in a catalog product with on-the-fly pricing scenario, there are multiple use cases:
For buy-links with on-the-fly pricing, this parameter is mandatory and has to be included in the signature.
|
| price | Required for dynamic products | For dynamic products, enter the product price. For multiple dynamic items, send the values separated by a semicolon. Example: price1;price2;price3. |
| tprices | Required for catalog product with trial pricing | For catalog products with trial pricing, the currency must be included in the buy-link. Multiple products not supported:
For buy-links with trial pricing, this parameter is mandatory and must be included in the signature.
|
| tperiod | Required for catalog product with trial pricing | The minimum tperiod number is 7 days. |
| currency | Required for catalog product with trial pricing | E.g.: currency=USD |
| tangible | Required for dynamic products | Boolean. Send TRUE or 1 for products that require physical delivery. |
| opt | Optional | Defines the product pricing options. URL formating rules: ":" is considered a pair separator
"," is considered a value separator
";" is considered a parameter separator between products
For buy-links with on-the-fly and trial pricing, this parameter is mandatory and has to be included in the signature. |
| description | Optional for dynamic products | For dynamic products, set a description that is displayed in the checkout page. The description field is displayed only for the 'One column with payment buttons' template. The description will not be visible in the default template. |
| recurrence | Required for dynamic products | For dynamic products, set product recurring options. Send multiple dynamic items separated by a semicolon. Example: period1:unit1;period2:unit2;. Possible values for units: DAY, WEEK, MONTH, YEAR, FOREVER. This parameter is conditioned by two other parameters: duration and renewal-price. |
| duration | Required for dynamic products | For dynamic products, set the duration of the recurrence. Send multiple dynamic items separated by a semicolon. Example: period1:unit1;period2:unit2;. Possible values for units: DAY, WEEK, MONTH, YEAR, FOREVER. This parameter is conditioned by two other parameters: recurrence and renewal-price. |
| renewal-price | Required for dynamic products | For dynamic products, set the price that should be applied to the renewal order. |
| product-additional-fields | Optional (only for new acquisitions, manual renewal, and custom prices) | For LISTBOX additional fields the value must be a valid value from the dropdown. |
| Cart behavior | Use the parameters below to control the purchasing flow. You can add a success URL for your finalized orders, change the cart template, add a source parameter or choose to place test orders.. | |
| merchant | Required | Your merchant identification code. The merchant code is available in Settings > Edit system settings, under the System settings tab. |
| subscription | Required for the manual renewal of catalog products | Unique system-generated identifier of your subscriptions. The subscription reference is available on Orders and customers → Subscriptions → Edit subscription details. |
| expiration | Optional | Buy-link expiry date. The link becomes invalid after the date from this parameter. Send as a UTC timestamp. Example: 1537549421 |
| return-url | Optional | URL to which customers are redirected after their finalized purchase. Learn more about Redirect URL on this article: https://verifone.cloud/docs/2checkout/Documentation/07Commerce/2Checkout-ConvertPlus/Set-a-redirect-URL-for-ConvertPlus-ordering-flows/ |
| return-type | Optional | The return method used for redirecting your customers after a successful sale. Possible values: Link, Redirect. Read more about redirect URL: https://verifone.cloud/docs/2checkout/Documentation/07Commerce/2Checkout-ConvertPlus/Set-a-redirect-URL-for-ConvertPlus-ordering-flows/ |
| coupon | Optional | Promotion coupon code discounting the price of a product added to checkout. You can send multiple values separated by semicolon when standalone coupons discount different products added to checkout. Example: &coupon=voucher1;voucher2. If this parameter is added to the buy-link, it has to be included in the signature. |
| src | Optional | Use this parameter to identify the source of your sales (which links are performing better). Example: src=prodpage or src=dldpage. |
| tpl | Optional | Cart template used for the checkout experience. Possible values: default, one-column. Use the style parameter to send ConvertPlus cart themes customized via Cart Editor. |
| currency | Optional | Preselected billing currency 2Checkout uses to charge your customers. |
| empty-cart | Optional | 1 or 0. Use for resetting cart contents. |
| back-url | Optional | Use this parameter behind the 'Back to Shopping' link in the shopping cart to redirect your customers to a website of your choice. |
| order-ext-ref | Optional | Use this parameter to set an external reference to the order. |
| language | Optional | Defines the language for the order interface. English is the default language. Available values for language codes are displayed in this article: https://verifone.cloud/docs/2checkout/Documentation/07Commerce/Checkout-links-and-options/2Checkout-supported-languages/ |
| origin-url | Optional | Set an origin URL for the purchase. |
| style | Optional | Use style for setting a customized cart template for the checkout experience. The parameter can be populated with the styling code assigned to each of your customized ConvertPlus cart themes. Contact 2Checkout to learn how to retrieve the styling code for your customized themes. |
| test | Optional | Use test=1 to place test orders. Exclude for regular order. Dummy credit card details are provided so you can test the entire order placing process. Guidance on the 2Checkout test ordering system is available here: https://verifone.cloud/docs/2checkout/Documentation/Test_ordering_system |
| customer-ref | Optional | The 2Checkout system generates default customer numerical (integer) IDs automatically for all orders of products that feature subscriptions. Can be used for new acquisitions aggregating new subscriptions under an existing Customer account. |
| customer-ext-ref | Optional | The external customer reference |
| lock | Optional (only for catalog products) | You can define customized packages or products for your shoppers and increase consistency and reconciliation between internal reporting, considering the details available at checkout and the ones valid when placing the order. Use the lock buy-link parameter which must be included in the signature along with other parameters that could impact the price: coupon, currency, lock, prod, qty, opt. When the cart is locked, the coupon field will not be visible anymore and the shoppers will not be able to add coupons to the cart. To enable, add the lock parameter to the generated buy-link, set it to 1 (lock='1') and sign it. |
| order-additional-fields | Optional (only for new acquisitions and manual renewal) | For LISTBOX additional fields the value must be a valid value from the dropdown. Example: order-additional-fields=field_identifier:value1,field_identifier2:value2 |
| Parameter | Required | Description |
|---|---|---|
merchant | Required | Your merchant identification code. The merchant code is available in Settings → Edit system settings, under the System settings tab. |
subscription | Required | Unique system-generated identifier of your subscriptions. The subscription reference is available on Orders and customers → Subscriptions → Edit subscription details. |
prod | Optional | Identifier of the product used in the renewal process. The product code is available on Setup → Products → Column code in the product listing. When included in renewal links, this parameter needs to be signed as well. |
qty | Optional | The number of units (quantity) for the renewed product. |
opt | Optional | Control the pricing option used in the renewal process.
|
language | Optional | Control the language used in the renewal process. Available values for language codes are displayed in this article. |
recurrence | Optional | The interval of time that will be added to the subscription lifetime starting with the current renewal/expiry deadline. For example 10:day |
| Parameter | Required / Optional | Description |
|---|---|---|
order-ext-ref | Optional | Use this parameter to set an external reference to the order. |
src | Optional | Control the order source identifier. You can track the source page by entering the following parameters: src=prodpage for the product page or src=dldpage for the link on the download page |
coupon | Optional | Promotion coupon code discounting the price of a product added to checkout. You can send multiple values separated by a semicolon when standalone coupons discount different products added to checkout. For example [...]&coupon=voucher1;voucher2[...] |
style | Optional | Control the cart template used during the renewal process. Each template defined in the Interface Templates area of the Control Panel has a unique identifier associated which is visible in the browser address bar when previewing the shopping cart. |
Upgrade option preselected and included in the Upgrade checkout
| Parameter | Required | Description |
|---|---|---|
merchant | Required | Your merchant code to identify your account. |
subscription | Required | Identifies the subscription that is being upgraded. Can be lifetime or recurring. |
prod | Optional | Adds a product as an upgrade option to the link (needs to be set up as a valida upgrade option for the initial product). Use separator %3B between 2 products e.g.
|
opt | Optional | Preselects the specified pricing option group&option for the selected product. e.g. opt=gr1:val1. Works only with preselected product (1 product per link). See more on this parameter. |
tpl | Optional | Checkout template code. Defaults to the template ID used in the previous order for the subscription. |
qty | Optional | The quantity of the product offered as upgrade offer. Defaults to the minimum quantity set per product. |
| Parameter | Required / Optional | Signed | Description |
|---|---|---|---|
merchant | Required | No | Your merchant code. |
prod | Required | Yes | Catalog product code. Multiple products: semicolon-separated (`prod=CODE1;CODE2`). |
qty | Required | Yes | Quantity. Multiple products: semicolon-separated (`qty=1;2`). |
price | Required | Yes | Price override. See Price Format below. |
currency | Required | Yes | ISO 4217 currency code (e.g. `USD`, `EUR`). |
opt | Optional | Yes | Pricing option codes, semicolon-separated. |
coupon | Optional | Yes | Coupon code. |
lock | Optional | Yes | Set to `1` to prevent the customer from modifying the cart. |
return-url | Optional | Yes | Redirect URL after a successful purchase. Use the unencoded URL when computing the signature. |
return-type | Optional | Yes | Redirect method: `redirect` (header redirect) or `link` (link on thank-you page). |
expiration | Optional | Yes | UTC Unix timestamp after which the link is no longer valid. |
order-ext-ref | Optional | Yes | External order reference. |
customer-ref | Optional | Yes | Numeric customer ID. |
customer-ext-ref | Optional | Yes | External customer reference (e.g. email). |
customer-lock | Optional | Yes | Set to "1" to lock all pre-filled billing/delivery information and route shoppers directly to the order review page. When set to "1", the following parameters need to also be included in the signature:
or
or billing fields
delivery fields
|
| Parameter | Description |
|---|---|
return-url | URL to which customers are redirected after their finalized purchase. Learn more about Redirect URL on this article. |
return-type | The return method used for redirecting your customers after a successful sale. Possible values:
|
expiration | Buy link expiry date. The link becomes invalid after the date from this parameter. Send as a UTC timestamp. Example: 1537549421 |
order-ext-ref | Use this parameter to set an external reference to the order. |
item-ext-ref | Set product identifier for your dynamic products. You can send multiple values separated by semicolon ;. |
customer-ref | The 2Checkout system generates default customer numerical (integer) IDs automatically for all orders of products that feature subscriptions. Can be used for new acquisitions aggregating new subscriptions under an existing Customer account. |
customer-ext-ref | The external customer reference. |
currency | Preselected billing currency 2Checkout uses to charge your customers. |
prod | The name of the dynamic product. For multiple products, send them separated by a semicolon. Example: name1;name2;name3. |
price | For dynamic products, enter the product price. For multiple dynamic items, send the values separated by a semicolon. Example: price1;price2;price3. |
qty | The number of units (quantity) for each product in checkout, separated by a semicolon;. Do not use spaces or blanks. Example: qty=2;1. qty works in conjunction with prod, based on their respective order. The first value of the qty parameter controls the number of units for the products whose identifier is in the first position of the prod parameter. Example: https://secure.2checkout.com/checkou...rchant=2COLNC&prod=6FD08E61B5;E2932D0DE2&qty=4;3 |
type | The type of dynamic product. Possible values:
If type is empty or not send, the default line item is considered product. For multiple dynamic items, send the values separated by a semicolon. |
opt | Defines the product pricing options. URL formating rules: ":" is considered a pair separator
"," is considered a value separator
";" is considered a parameter separator between products
|
description | For dynamic products, set a description that is displayed in the checkout page. The description field is displayed only for the 'One column with payment buttons' template. The description will not be visible in the default template. |
recurrence | For dynamic products, set product recurring options. Send multiple dynamic items separated by a semicolon. Example: period1:unit1;period2:unit2; Possible values for units:
*This parameter is conditioned by two other parameters: duration and renewal-price. |
duration | For dynamic products, set the duration of the recurrence. |
renewal-price | For dynamic products, set the price that should be applied to the renewal order. |
| Requirement | Details |
|---|---|
| Feature enabled | The SSO in Cart setting is active on your merchant account. |
| Customer identifier | The buy-link includes either customer-ref (2Checkout customer reference) or customer-ext-ref (external customer reference). |
| Valid expiration | The buy-link includes an expiration parameter set to a UTC Unix timestamp in the future. |
| Valid signature | The buy-link is signed with a valid HMAC-SHA256 signature using your Buy Link Secret Word and includes all needed parameters. |
| Parameter | Required | Signed | Description |
|---|---|---|---|
customer-ref | One of the two | Yes | The numerical 2Checkout customer reference ID. |
customer-ext-ref | One of the two | Yes | The external (vendor-side) customer reference. |
expiration | Yes | Yes | UTC Unix timestamp indicating when the buy-link expires. e.g. expiration=1893456001 |
signature | Yes | — | HMAC-SHA256 hash generated from your signed parameters. See Signature generation. |
lock | No | Yes | When present, locks all cart content and thus makes it non-editable. |
lock-customer | No | Yes | When present, locks all customer, billing delivery and shopping information and takes the user directly to the Review step of the Checkout flow. Compatible with new acquisition orders. |
Variant 1 — Editable checkout with pre-filled billing details and saved cards.
The Card details section shows saved cards with an empty Security code field.
Variant 2 — Locked checkout with pre-filled billing details and saved cards.
The Card details section shows saved cards with an empty Security code field.
| Cart type | Supported templates |
|---|---|
| ConvertPlus | All templates |
| Inline Cart | All templates |
| 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, Google Pay, 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:
|
| 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 |
| Automatic renewal | Supported |
| Tax collection and VAT Information Exchange System | Supported |
| US B2B Tax Exemption | 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 | 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 |
| Attributes | Type / Description |
|---|---|
code | String Product code assigned by you when creating the product. Required for catalog products. |
type | String Product type. Required only for dynamic products. Possible values: [PRODUCT, SHIPPING, TAX]. Default value is PRODUCT. |
name | String Product name. Required for dynamic products. |
price | String - for dynamic products Product price. It is required for dynamic products. Object - for catalog products with on-the-fly pricing Product price; required for catalog products with on-the-fly pricing and includes value and currency. |
tangible | String Product tangible flag. Required only for dynamic products. Default value is FALSE. |
quantity | String Product quantity. Default value is 1. Required for catalog products with on-the-fly pricing. |
options | Array The product price options. It is supported for both catalog and dynamic products. Required for catalog products with on-the-fly pricing. Product price options structure for dynamic products:
Product price options structure for catalog products:
|
recurrence | Object Required for dynamic products. Possible values:
This parameter is conditioned by two other parameters: duration and |
duration | Object Sets the duration of the recurrence. Required for dynamic products. |
renewalPrice | Integer Sets the price to be applied to the renewal order. Required for dynamic products. |
| Methods | Description |
|---|---|
| add | Adds a single product to the list. Use the above list of parameters to add a product to cart. |
| remove | Removes a product from the list. |
| addMany | Adds an array of product objects to the main list. |
| removeAll | Removes all products from the list. |
| getAll | Retrieves the products list. |
| Attributes | Type / Description |
|---|---|
name | String Customer billing name. Example: "John Doe". |
email | String Customer billing email. Example: "john.doe@email.com". |
phone | String Customer billing phone number. Example: "403940281923". |
country | String Customer billing country. Example: "US". |
city | String Customer billing city. Example: "Los Angeles". |
state | String Customer billing state. Example: "California". |
zip | String Customer billing zip code. Example: "90078". |
address | String Customer billing address. Example: "1093 Rodeo Drive". |
address2 | String Customer billing additional address information. "293 Postal Box". |
company-name | String CompanyName When sending the Company name the Company checkout flow will be triggered. Otherwise, the default checkout flow for InLine cart is the individual flow. |
fiscal-code | String fiscalCode When sending the Fiscal code, the Company checkout flow will be triggered only if also another company flow relevant parameter will be also sent (Company name and/or Tax office). Otherwise, the default checkout flow for InLine cart is the individual flow. |
tax-office | String taxOffice When sending the Tax office the Company checkout flow will be triggered. Otherwise, the default checkout flow for InLine cart is the individual flow. |
| Methods | Description |
|---|---|
| setData | Sets the entire billing data. |
| setName | Sets the billing name. |
| setEmail | Sets the billing email. |
| setPhone | Sets the billing phone. |
| setCountry | Sets the billing country. |
| setCity | Sets the billing city. |
| setState | Sets the billing state. |
| setZip | Sets the billing zip code. |
| setAddress | Sets the billing address. |
| setAddress2 | Sets additional billing address information. |
| reset | Resets the billing data. |
| setCompanyName | Sets the billing Company name. |
| setFiscalCode | Sets the billing Fiscal code. |
| setTaxCode | Sets the billing Tax code. |
| Attributes | Type / Description |
|---|---|
name | String Customer shipping name. Example: "John Doe". |
email | String Customer shipping email. Example: "john.doe@email.com". |
phone | String Customer shipping phone number. Example: "403940281923". |
country | String Customer shipping country. Example: "United States of America". |
city | String Customer shipping city. Example: "Los Angeles". |
state | String Customer shipping state. Example: "California". |
zip | String Customer shipping zip code. Example: "90078". |
address | String Customer shipping address. Example: "1093 Rodeo Drive". |
address2 | String Customer shipping additional address information. "293 Postal Box". |
| Methods | Description |
|---|---|
| setData | Sets the entire shipping data. |
| setName | Sets the shipping name. |
| setEmail | Sets the shipping email. |
| setPhone | Sets the shipping phone. |
| setCountry | Sets the shipping country. |
| setCity | Sets the shipping city. |
| setState | Sets the shipping state. |
| setZip | Sets the shipping zip code. |
| setAddress | Sets the shipping address. |
| setAddress2 | Sets additional shipping address information. |
| reset | Resets the shipping data. |
| Attributes | Type / Description |
|---|---|
source | String Sale originating source. Example: "YouTube Channel". |
language | String Cart language code. Example: "FR". |
currency | String Cart currency code. Example: "USD". |
test | Boolean Test order flag. Possible values:
|
setReturnMethod | String Sets the |
coupon | String Order promotion coupon. Example: "50%off". |
token | String Token for the authorization code. |
expiration | String The expiration date for the authorization. |
orderExternalRef | String The unique identifier of an order placed in the 2Checkout system, mirroring the reference you're using to manage order data in your system. |
CustomerReference | Integer The 2Checkout system generates default customer numerical (integer) IDs automatically for all orders containing products that feature subscriptions. Can be used for new acquisitions aggregating new subscriptions under an existing Customer account. |
ExternalCustomerReference | String The external customer reference. |
autoAdvance | Boolean Auto-advanced flag. Possible values:
|
| Methods | Description |
|---|---|
| register* | Makes the products, billing, shipping, cart and formParser services available. These services are unavailable unless this method is called. |
| checkout | Starts the cart service which displays the overlay payment form. |
| addCoupon | Adds a coupon to the coupons list. |
| addCoupons | Adds coupons in the cart from a list array. |
| removeCoupon | Removes a coupon from the coupons list. |
| removeCoupons | Clears all coupons from the cart instance. |
| setSource | Sets the order source. |
| setCurrency | Sets the currency on the cart instance. |
| setLanguage | Sets the language code for the order. |
| setReturnMethod | Sets the ReturnMethod object by calling TwoCoInlineCart.cart.setReturnMethod({url, type}). URL to which customer is redirected after a successful payment. Example: https://www.merchant-website.com. |
| setTest | Send true for placing a test order. |
| setLoaderState | Handles the overlay window visibility. |
| setIframeState | Handles the loader visibility. |
| reloadCart | Reloads the cart instance. |
| setOrderExternalRef | Sets the order external reference. |
| setCustomerReference | Sets 2Checkout customer reference. |
| setExternalCustomerReference | Sets external customer reference. |
| setCartLockedFlag | Boolean Lock cart flag. Possible values:
|
| setIframeLoad | One string parameter: 'immediate' or 'delayed'. Additionally, the InLine cart can also be set by using TwoCoInlineCart',{"app":{"merchant":"MERCHANT_CODE", "iframeLoad": "immediate"} instead of TwoCoInlineCart.setup.setIframeLoad. |
| setIframeLoadDelay | One number parameter; sets the time in milliseconds. Modify the pre-loading time of the cart iframe by adding a delay using the TwoCoInlineCart.setup.setIframeLoadDelay method. |
| setReset | Boolean Erases all previous cart sessions from the customer's browser upon opening a new cart to avoid overlapping of the buy-link parameters. Possible values:
|
| cart.setAutoAdvance | Sets the auto-advanced cart behavior. If all mandatory checkout parameters are prefilled, the shopper is advanced to the payment details page. |
| addAdditionalField | Sets an additional field for your account. |
Make sure your parent subscription has upgrades available in Control Panel, for your current product.
| Use case — To achieve the desired result use the corresponding cardholder names. | Cardholder name |
|---|---|
| Successful authorization for the initial transaction and all recurring charges. | John Doe |
| Successful authorization for the initial transaction and manual renewal transactions but recurring charges fail to authorize with the Insufficient Funds error message. | Mike Doe |
| Successful authorization for the initial transaction and manual renewal transactions but recurring charges fail to authorize with the Stolen Card error message. | Jenny Doe |
| Insufficient funds | Mona Doe |
| Try again later | Mark Doe |
| Stolen card | Red Doe |
| Authentication failed | Joy Doe |
| Expired card | Angela Doe |
| Invalid card number | Adrian Doe |
| Invalid CVV | Jack Doe |
| English | Native | 2Checkout language codes |
|---|---|---|
| Arabic | العربية | ar |
| Brazilian Portuguese | Português do Brasil | pt-br |
| Bulgarian | български език | bg |
| Chinese Mandarin Traditional | 繁体中文 | zy |
| Chinese Simplified(Cantonese) | 中文 | zh |
| Croatian | Hrvatski jezik | hr |
| Czech | Česky | cs |
| Danish | Dansk | da |
| Dutch | Dutch | nl |
| English | English | en |
| Finnish | Suomi | fi |
| French | Français | fr |
| German | Deutsch | de |
| Greek | Ελληνικά | el |
| Hebrew | עִבְרִית | he |
| Hindi | हिन्दी | hi |
| Hungarian | Magyar | hu |
| Italian | Italiano | it |
| Japanese | 日本語 | ja |
| Korean | 한국어 | ko |
| Norwegian | Norsk | no |
| Persian | فارسی | fa |
| Polish | Polski | pl |
| Portuguese | Português | pt |
| Romanian | Română | ro |
| Russian | Русский | ru |
| Serbian | Србија | sr |
| Slovak | Slovenčina | sk |
| Slovenian | Slovène | sl |
| Spanish | Español | es |
| Swedish | Svenska | sv |
| Thai | ไทย | th |
| Turkish | Türkçe | tr |
Shoppers in the U.S., Puerto Rico, and Marshal Islands are required to provide a valid ZIP code for their location. The same requirement does not apply to shoppers worldwide.