Learn how to handle APIv6 error codes.

Overview

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

• Create promotion

• Update promotion

• Retrieve a promotion

• Search promotions

Promotion object

Overview

The Affiliates object helps you to search and extract information about your affiliates. 

The methods below will return the affiliate(s) details only if they (the affiliates) are associated with the merchant. Otherwise, they will return an error (invalid request). This will happen even if the affiliate code provided belongs to a valid affiliate from the Affiliate Network, but one that's not associated with the vendor making the calls.

Overview

Upselling is the practice that allows you to invite your customers to purchase a higher-end product, an upgrade, or an additional item in order to make a more profitable sale. The 2Checkout Public API supports upsell campaigns through which you can recommend catalog products to your shoppers.

UpSell Object

Use the UpSell object in order to recommend products to customers via the JSON-RPC API 6.0.

Parameters

Overview

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

Drupal Commerce is revolutionary software integrating commerce, content, and community to create engaging Web experiences that bring e-retailers more traffic to drive more results. With Drupal Commerce, online retailers have a simple yet powerful platform and the flexibility to integrate a rich commerce experience anywhere within their environment.

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.

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

Drupal Commerce Settings 

Perform the below set of instructions in your Drupal Commerce 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 Drupal Commerce admin area.
4. Navigate to Commerce → Configuration → Payment and click on Payment gateways.

5. On the Payment gateways page, click on Add payment gateway.

6. On the Add payment gateway page, select 2Checkout ConvertPlus by Verifone/2Checkout InLine by Verifone/2Checkout 2Pay.js.

7. Fill in the rest of the fields on the page:

• Display name
• Mode (select Test to be able to place test orders)
• Merchant Code - This is the 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)
• Conditions

8. Select Enabled to activate the plugin.

9. Click Save.

About Drupal Commerce

Drupal Commerce is revolutionary software integrating commerce, content, and community to create engaging Web experiences that bring e-retailers more traffic to drive more results. With Drupal Commerce, online retailers have a simple yet powerful platform and the flexibility to integrate a rich commerce experience anywhere within their environment.

Drupal Commerce provides the structure you need to do eCommerce without any assumptions about how your business is done.

Comparative report showing the evolution of the total revenue and monthly recurring revenue over the past 12 months. Includes data for finished and refunded orders. The report also shows the percentage of renewal orders out of the total revenue. During currency conversion, the report uses the average exchange rate calculated for each month.

Monthly Recurring Revenue (MRR) is an excellent tool to understand how much of the total revenue per month is made up from renewals (customers that extended their subscriptions).

• Selecting a billing currency centralizes data for finished and refunded orders paid in the specified currency.
• Selecting the default payout currency centralizes data for all finished and refunded orders settled in the default payout currency, excluding the ones settled in any of the other settlement currencies.
• Selecting a non-default payout currency centralizes data for all finished and refunded orders settled in the selected currency.

Overview

2Checkout's lead management is a smart and easy way to reduce customer churn and gain useful insights into what drives customers to cancel automatic renewals. Use the Lead object to configure lead management campaigns via JSON-RPC API 6.0 to reduce unfinished payments and cart abandonment.

You can use lead management to:

• run a report on unfinished payments
• send abandoned shopping cart follow-up emails
• request invoices

Overview

You can use the Estimated current balance table to check the approximate account balance and find information on your estimated next payment.

Once logged into your Merchant Control Panel, you can access the report from Accounting → Estimated balance.

The amounts expressed in this report are estimated and may change as a result of new account activity.

Account information

On the Estimated current balance page, you can see the most important financial metrics from your account. You can view the amount that will be remitted to you at the next payout, the total balance amount that 2Checkout owes you, and the minimum transfer limit set on your account.

Estimated next payment

Use the Estimated next payment card to view the amount that will be remitted to you at the next payout by 2Checkout. The Estimated next payment amount is expressed in the payout currency available on your account.

Deposit balance

Use the Deposit balance card to view the total amount 2Checkout owes you for the deposits retained on your account. Your account Deposit balance is computed by adding up the deposit amounts withheld in the past 90 days. Deposits are released back to you in the next payment cycle occurring 90 days from the date when the deposit was initially withheld.

The Deposit balance amount is displayed in the payout available on your account.

Minimum transfer limit

Use the Minimum transfer limit card to view the amount you need to reach to receive payouts from 2Checkout.

To update/change your minimum transfer limit set for your account, click on the Change button or go to your Settings area to submit your request to our Financial Operations team. 

Report information

The estimated current balance report returns account balance information for each of your payout currencies. In case you have updated your payout currency, data from the table is displayed using your new payout currency.

The time zone used for displaying the data is GMT+2. Your current account balance is split based on:

• Reporting period - Sales, fees, refunds, and any activity with financial impact are displayed within the reporting period when it incurred. For each reporting period row, 2Checkout displays the Estimated payout date (when your payout will be remitted). Note that the estimated payout date might change if your transfer limit is not reached.
• Amount source - Your account balance is displayed based on the amount source type (sales, fees, refunds, chargeback fees, reserves retained, reserves released, or transfer type).

Sales 

Sales deposited included into payout balance. Click on the Sales amounts to be redirected to the Order search and view the data underlying the amounts displayed in the Estimated current balance page.

To extract detailed information on your sales, follow these steps:

1. Log into your Merchant Control Panel.
2. Navigate to Orders & customers → Order search.
3. Run a report for your completed sales (status Finished) for the period reported in the estimated current balance.
4. Export the information and check the total sales amount.

Fees

To see the processing fees charged by 2Checkout for the sales included in the balance, click on the Fees amounts to be redirected to the Order search and view orders for which 2Checkout applied processing fees.

To retrieve additional information on your fees, follow these steps:

1. Log into your Merchant Control Panel.
2. Navigate to Orders & customers → Order search.
3. Run a report for your completed sales for the period reported in the estimated current balance.
4. Export the information and check the processing fee amounts in your payout currency.

Refunds

This amount represents the orders refunded in the reported period. Click on the Refunds amounts to be redirected to the Order search and view orders for which 2Checkout applied processing fees.

To retrieve additional information on your refunds, follow these steps:

1. Log into your Merchant Control Panel.
2. Navigate to Orders & customers → Order search.
3. Run a report for your processed refunds (status Refunded) for the period reported in the estimated current balance.
4. Export the information and check the refund amounts in your payout currency.

Services/Adjustments 

Various adjustments refer to the collection of a negative balance, the return of fees on a canceled sale, or any other special requests.      

Contact 2Checkout's Financial department for additional information regarding the amounts retained as adjustments.

Chargeback Fees

Chargeback fees are the fees applied by 2Checkout for chargebacks opened in the reported period.

To retrieve additional information on your chargeback fee, follow these steps:

1. Log into your Merchant Control Panel.
2. Navigate to Reports Center → Main reports.
3. Expand the Financial reports section and select Chargeback reports.
4. Run a report for your disputes opened in 2Checkout for the previous reporting period.
5. Check your total dispute rate used for calculating the chargeback fee.            

Retained to disputes balance

This is the amount retained for orders with chargeback requests initiated.

To retrieve additional information regarding the dispute balance retained amounts, follow these steps:

1. Log into your Merchant Control Panel.
2. Navigate to Reports Center → Main reports.
3. Expand the Financial reports section.
4. Go to the Monthly revenue split report and click on Set up report.
5. On the Revenue split page, select the period for which you want to run the report.
6. Select the Disputes balance checkbox.
7. Click on the Build report button.
8. On the next page you'll be able to see both the Retained to disputes balance as well as the Released from disputes balance.

Released to disputes balance

This is the amount released for orders with closed chargeback requests. To retrieve additional information regarding the dispute balance released amounts, follow the same steps as those for the Retained to disputes balance.

Transfer fee 

Transfer fees are amounts charged by 2Checkout for the payment transfer. Transfer fees are charged only for the payout method International Wire.

Contact 2Checkout's Financial department for additional information regarding the transfer fees charged for your payouts.         

Overview

Define additional checkout fields to be displayed in the shopping cart, helping you collect extra information from your shoppers. You can configure custom fields to be displayed at both product and order levels.

Availability

This functionality is available for all 2Checkout accounts.

How do I receive additional checkout fields?

Customer-specific information collected via custom additional fields is sent in several ways:

• in the "Order notification email" - sent by the 2Checkout system, information filled by your customers will be sent along with all the order information in the Additional Information section.
• in the "IPN (Instant Payment Notification)" - if this service is enabled, the additional fields are included in the HTTP POST sent by the 2Checkout system.

Additional checkout fields are not included by default in the IPN HTTP POST. To include these fields, as well as other additional order information you have to check CUSTOM_FIELDS[] on the IPN Settings page.

The following IPN variables are available:

additional checkout fields

Product additional checkout fields (dynamic fields):

Product name: 123456 

Product ID in the 2Checkout system: 123456

Additional information can be found in the Merchant Control Panel in these sections:

• IPN Settings
• Additional fields

Create custom fields

1. Go to Setup → Ordering options.
2. Click Manage additional order fields.
3. Use the Add new field section to define each new field. Enter the Field identifier. Use unique identifiers for all your fields. Note: This field accepts only alpha-numeric characters. If you leave this field empty, 2Checkout generates a random value as an identifier.
4. Enter the Field text (the name of the field).
5. Set the Field type. There are four available types.
   
   • Textbox allows shoppers to write what they want in the field. You can use it to collect feedback or opinions on the shopping experience, for instance.
   • Checkbox allows shoppers to select various options. You can use it for a quick survey.
   • Listbox displays a drop-down list your shoppers can select items from.
   • Hidden helps you define custom URL parameters for tracking purposes. For details on this option, read our dedicated article.
6. Use the Apply to drop-down to choose whether the field should apply at the product or order level. 
7. Use the Validation rule field to specify the regular expression to validate the field values. Note: Not supported on Inline Checkout. The field can be set, but it will be ignored during the checkout process.
8. Click Create field to save the new field.

Set additional checkout fields for products

Requirement

Follow the steps in the Create custom fields section to create new fields and apply them at the Product level. Then, follow the steps below to assign the field to a product.

1. Go to Setup → Products.
2. Click Edit on the product you want to assign the field to.
3. Go to the Information tab and scroll to the bottom of the screen. You'll find the previously defined additional fields in the Order additional fields section. All new fields are disabled by default.
4. Check the Enabled option on the Order page column corresponding to the field you want to use. Check the Required checkbox if you want the field to be mandatory during the checkout process.
5. Click Save.

Set additional checkout fields for orders

Requirement

Follow the steps in the Additional fields settings page in your Merchant Control Panel to create new fields and apply them at the Order level. Then, follow the steps below to assign the field to order.

1. Go to Setup → Ordering options.
2. Scroll down to the Additional order fields section and got to the Click here to create and manage link.
3. To create a new additional field, follow these steps:
   
   • Go to the Add new field section
   • Fill in all the fields displayed
   • Click Create field to save the new field.
4. To edit an existing additional field, you need to:
   
   • Go to Dashboard → Setup → Ordering options → Additional fields settings
   • Scroll below the Additional fields settings section
   • Choose the field you want to modify and update its fields.
   • Scroll to the bottom of the page and click Update fields to save your new settings.
5. To delete an additional field, leave the field empty and click on the Update fields button. Those fields assigned to products will be deleted as well.
6. To activate an existing additional field, see the steps below:
   
   • Go to Dashboard → Setup → Ordering options → General
   • Scroll down below the Additional order fields section.
   • In the list of additional fields, check the checkbox next to the field you want to use. 
   • Check the Required checkbox if you want the field to be mandatory during the checkout process.
   • Click Save Settings at the bottom of the page.

Additional field types

• Textbox - a text field that allows the customer to enter text information about the additional field.
• Checkbox - a small checkable box that allows the customer to enable or disable an element. It can be checked or left empty.
• Listbox - it displays a scroll-down list of elements that allow the customer to select one or more items from the list contained within the static text box.
• Hidden - it cannot be seen or modified by customers.

Pre-fill additional information fields

You can pre-fill the additional information fields by passing the &ADDITIONAL parameter in the URL.

The parameter would look like this: &ADDITIONAL_(insert additional field identifier here)[product id]=(insert value here).

For example, if you want to pre-fill the additional information field with 'test.com', your checkout buy-link would look like this:

&ADDITIONAL_92E8A6[4674306]=test.com

Where ADDITIONAL_92E8A6 is the URL parameter as shown in your Merchant Control Panel.