Overview

Use this object to create new orders and collect payments from shoppers. 

The attributes below in this page include all possible properties from both the request and the response. 

To implement placing orders, please reference the API Request page (Place orders with catalog products or Place orders with dynamic product information).

Supported payment methods

1. Credit/Debit cards: Visa, Visa electron, MasterCard, Maestro, Amex, Discover, Dankort, Carte Bleue, JCB. 2Checkout supports local Brazilian cards.
2. PayPal and PayPal Express
3. Purchase Order
4. Wire
5. Check
6. WeChat Pay
7. iDEAL
8. Previous order references - In addition to the payment methods enumerated above, 2Checkout also supports 1-click purchase flows in which you use valid previous order references belonging to returning customers to pay for new orders with their previously used cards and PayPal accounts. 

Attributes

Use the 2Checkout Channel Manager API to manage partner and reseller orders.

Availability

The partner API methods are available only in tandem with the Channel Manager module.

Requirements

Contact 2Checkout to start using the Channel manager API.

1. Use the following URL: https://api.avangate.com/channel-manager/2.1/rpc/
2. Authenticate using the login method and create a session (connection).
3. Set partner
4. Throughout the lifetime of the session (max 10 minutes), you can invoke all 2Checkout API methods. To invoke methods you need to send a request to 2Checkout. Read more on the request object below.
5. The 2Checkout system provides responses to all requests. Read more on the response object below.

Response

Whenever you call an API method, 2Checkout replies with a response. The response is a single object serialized using JSON.

There are two types of response, with the properties detailed below.

Valid response

{
"id" : <int identifier>,
"jsonrpc" : 2.0,
"response" : {<return object>}
}

Invalid response

{
"id" : <int identifier>,
"jsonrpc" : 2.0,
"error" : { "code" : <int error code>, "message" : "<error message>"}
}

Request

Calling API methods involves sending an API request to Avangate. The request object is detailed below. 

{ 
"jsonrpc" : 2.0, 
"id" : <int identifier>, 
"method" : "<methodName>", 
"params" : [<parameters array>] 
}

Overview

The object includes information related to the upsell campaigns, including product information and discount settings.

UpSell Object

The object below is returned as a successful response for the following JSON-RPC API 6.0 methods:

• Create an upsell campaign

Overview

For every open dispute, 2Checkout applies a fee, set in your account's default currency. Chargeback rates formula:

Chargeback rate = no. of opened chargebacks (regardless of their current status) in the selected chargeback interval divided by the number of transactions in the same period.

Fixed chargeback fees for each chargeback

This case implies a fixed fee in a single currency for each open dispute.

Threshold-based chargeback fees

This case implies fees with variable values depending on the chargeback rate of your account. 2Checkout agrees on certain chargeback rate thresholds together with you and applies the fees accordingly. Thresholds and chargeback fees may vary for each account. You can see the thresholds applied to your account on the Chargeback reports page.

The chargeback rate used as a threshold is the one from the end of the previous month.

Where can I see my chargeback fees?

You can see the 2Checkout fees for your chargebacks in multiple areas throughout the 2Checkout platform:

Accounting report

1. In the Total chargeback fee column in the email's body.
2. In the 2Checkout orders with chargeback fees balance.csv report attached to the email.

Control panel

1. On the 2Checkout dashboard, in the Chargeback Fees field of the Account balance section.
2. In the Revenue Split report, on the Chargeback Fees field.
3. In the Account Balance report on the Chargeback Fees column.

To grow the average dollar amount that customers spend when placing orders, you can rely tried and tested strategies that favor working smarter rather than harder. To boost your Average Order Value (AOV), you can:

1. Offer a Discount at a Threshold. Knowing that people are usually drawn to offers, you can increase your AOV by offering a discount for a minimum order amount. 

2. Market to repeat customers. It is always easier and cheaper to keep an existing customer than to locate a new one. 

3. Test, test and test. Base your business decision on actionable data that you can extract from A/B testing. 

Follow the path we set up for you to grow your AOV with the tools at your disposal in your 2Checkout account. 

Overview

You can add partners in two ways:

• Via the partner sign-up form
• Adding them manually

Partner sign-up form

Interested parties can join your partnership programs by filling the sign-up form and choosing the program they are interested in joining.

Follow the steps below to generate a partner sign-up form link.

1. Go to Setup -> Generate links.
2. Go to the Partner Links tab.
3. Select the template that you want the form to use.
4. Select the Sign-up page type.
5. Add the generated link to your website.

Once an interested party requests a partnership, you can approve, reject or delete their request from the Control Panel.

• If you confirm the request, 2Checkout sends an email to the partner, informing him/her of the request approval. You can see the new partner in the list of partners.
• If you delete the partner, 2Checkout doesn't send any email. The deleted partner/request is not displayed anywhere.
• If you reject the request, 2Checkout informs the partner via email about the rejection. You can still see the partner in the partner list with the status Rejected.

Partnership status

Partnership requests can have one of the following statuses.

• Active = Partner account approved and active
• Inactive = Partner account approved but deactivated by you
• Rejects = Partnership request rejected
• Pending = Partnership request under evaluation

Adding partners manually

If none of your partnership programs are published in the form, you can assign partners manually to a partnership program or create individual settings for them.

Follow the steps below to manually add a partner to a partnership program.

1. Login to the 2Checkout Merchant Control Panel.
2. Go to Partner management -> Partners.
3. Click Add partner.
4. Fill in the partner details.
5. Click Save partner.
6. After filling this section, the partner is saved as Inactive. You need to fill in the Commercial settings and Financial details sections before partner activation.

Commercial settings

Payment methods

Select the business model that you want the partner to use:

• Reseller - payments to 2Checkout as a master reseller. 2Checkout handles all aspects regarding payment, money collection, invoicing and delivery of the subscription/activation keys.
  • Characteristics:
    • 2Checkout details are present on the Partner Invoices.
    • Multiple payment options are available, depending on the order currency (Visa/MasterCard/Eurocard; Bank/Wire transfer).
    • Payments Risk Management handled by 2Checkout.
    • Automatic shopper invoices sent by 2Checkout to your partners.
• Direct - partners pay directly through our pflatform.
  
  • Characteristics
    • Your company details are present on the Partner Invoice.
    • Direct payments to your accounts via Bank/Wire transfer.
    • Shopper invoices are handled by your company.

When selecting the transactional currency, the available payment methods will be displayed.

Partnership settings

You can configure partnerships to use two types of settings:

• Create individual settings. Useful if you want to create unique settings per partner and avoid applying the settings of a partnership program.
• Add to existing partnership programs. Useful if you want to apply settings previously defined in the partnership program.

• Assigning a price list. Use price lists to:
  • Define a price in different currencies and assign them to regional partners;
  • Limit a partner access to a certain number of products;
  • Define special prices per product /different currencies;
• Partner geographic coverage. Depending on the partner geographic focus, you can select the countries where your partner is allowed to sell.
• Account manager. Select the person responsible of the partner relationship. You can also select a backup account manager. The account managers have access only to data regarding their partners if the standard use role is assigned to them.

Financial details

Fill in the Financial details. Mandatory fields:

• Company registration name. The legal name of the company;
• Company registration number. The legal identifier of the company;
• Address, City & Country. The legal address.

Partner invoice settings

Decide when to generate partner invoices:

• Manually - you will have to manually create Partner Invoices to receive payments for orders;
• Automatically after each order;
• On a specific day of the month.

You can still generate partner invoices manually even if they are set to be generated automatically after each order or on a specific day of the month. 

• Allow this partner to generate partner invoices. Through this setting the partner can generate partner invoices. By granting partners access to this feature, they can group orders in a single partner invoice.

Users

Add and manage partner account users. Use the drop-down menu to grant user management rights to the partner. Additionally, you can add or configure user roles.

Overview

You can change a number of parameters impacting specific orders incentivizing your partners. 

Partners can request the revision of discount and margin values through comments. But you can also take it upon yourself to also change the data when placing orders on behalf of your partners. 

Opportunity registration

The edit order functionality offers Opportunity Registration capabilities, enabling partners to place orders that function as opportunity registration equivalents. Partners can indicate that they're in fact registering an opportunity while placing an order by leveraging the comments field to ensure you are aware of the support they require and financial consideration needed. You can easily view such partner requests, and update order details to accommodate demands. 

1. To edit the discount details of a partner order you need to select Order search in the left hand side pane of the Control Panel, Click on Partner orders and filter existing items to show only those with the Pending approval status. You can always also just search for a partner order, if you have specific details on hand.
2. Once you identified the order you'd like to refresh, click View and then Edit Order.
3. Take advantage of this feature to modify details such as the Discount, Extra margin, and Total Price, offering your partners better deals than available by default. Altering any of the values mentioned above will automatically cause the others to adapt and reflect the change introduced.

Use cases

1. In case the partner invoice was not issued, you can go ahead and alter the discount values as you see fit. When the partner is generated, it will contain only the final, updated details of the order. Partner invoices are issued on-demand either by you, when the Partner invoices settings are configured to generate partner invoices manually for one or more orders at once, or by your partners when the Allow this partner to generate partner invoices option is enabled, but only if you defined a Credit limit in both cases. You also have the option of automating the issuing of partner invoices, generating them automatically on a specific day of the month.
2. In case the partner invoice was already issued but not paid, you will need to cancel the existing partner ahead of anything else, and subsequently to delete it if it has become irrelevant. Only then will you be able to make the necessary changes to the order. Once all modifications are in place, the partner can be reissued. Partner invoices are issued in tandem with orders for those partner accounts with Partner invoice settings configured to generate them automatically for each order. Partner accounts for which you set no Credit limit will create partner invoices automatically with each order, regardless of the Partner invoice settings for that specific partner. 

Limitation

• In the eventuality in which an issued partner was already paid, the Edit Order feature is no longer available. You should consider refunding your partner the amount that would have been provided through an increased discount. Partners will receive email notifications of the changes you operate to orders, with messages being issued for each edit. At the same time, the Partner Control Panel will reflect the update in the Order Comments area. 
• Options such as quantity and the products in a specific order cannot be changed using the Edit Discounts feature.

Overview

Use the Promotion object to create/update and update information on discounts/promotions you set up for your account.

Parameters