Overview

The 2Checkout system creates Customer IDs by default for all subscriptions it generates.

Unique customer IDs

Customers purchasing products/subscriptions sold through the 2Checkout platform can be assigned a unique customer IDs that you control in addition to the unique 2Checkout customer IDs created and assigned automatically.

External Customer IDs and 2Checkout Customer IDs are complementary.

Customer IDs can be:

• Unique alphanumeric ID (string) defined per-customer.
• Unique numerical (integer) ID generated by the 2Checkout system automatically.

Create external customer ID 

When changing the Customer billing details of an account, you also have the option of providing the external customer ID if none exists.

You can enter any unique alphanumeric ID (string) as long as it's not already used as the external identifier of an existing Customer, in which case you'll receive the following error message: "The External ID you entered is used by another customer account. Please enter a new External ID and try again."

Edit external customer ID 

When changing the Customer billing details of an account, you also have the option of editing an existing external customer ID.

External references can be swapped for any unique alphanumeric ID (string) you wish as long as an existing customer account in the 2Checkout system isn't already using the same identifier.

Import customer IDs

When importing subscriptions, the 2Checkout system automatically generates subscriptions to match the data in the CSV file used for the importing process.

The existing importing functionality of the 2Checkout system was expanded to support external customer IDs. In this regard, you can specify an ExternalCustomerId for each of the subscriptions that you import.

Importing a new subscription

Specify the desired ExternalCustomerId in the column of the CSV file when importing a new subscription to have the 2Checkout system create a new Customer Account with the identifier for that specific subscription.

Edit customer IDs

Use the subscription import functionality offered by the 2Checkout platform in order to edit customer IDs.

Specify a new ExternalCustomerId in the column of the CSV file when importing an existing subscription to have the 2Checkout system update the associated Customer account, replacing the old ID with the new identifier.

Customer IDs in LCNs and IPNs

AVANGATE_CUSTOMER_REFERENCE - Default customer numerical (integer) IDs generated automatically by the 2Checkout system.

EXTERNAL_CUSTOMER_REFERENCE - Unique customer alphanumeric (string) identifiers that you control.

The 2Checkout system creates the Avangate Customer ID (AVANGATE_CUSTOMER_REFERENCE) by default for successfully placed orders that include products generating subscriptions. AVANGATE_CUSTOMER_REFERENCE is always included in both IPN and LCN.

Unique customer identifiers (EXTERNAL_CUSTOMER_REFERENCE) that you control are only included in LCN and IPN provided that you set them up via:

• The Buy Link using the CUSTOMERID parameter
• Orders placed using the 2Checkout API 

In scenarios in which you don't provide a unique customer identifier, EXTERNAL_CUSTOMER_REFERENCE will be empty in both IPN and LCN when they're first sent out.

Adding a unique customer identifier after the order was finalized won't trigger the LCN on its own. However, the next time that the LCN is generated for updates impacting the license directly, the notification will also include the EXTERNAL_CUSTOMER_REFERENCE you added. The same behavior applies to scenarios in which you move a subscription under a specific customer.

Buy-link Customer ID Parameter

External customer ID in buy-links

Create new Customer accounts for subscriptions generated when shoppers purchase your products. You can use the CUSTOMERID (case sensitive) parameter to set external identifiers in the buy links of the products purchased by your customers. Note: Products need to have the renewal system enabled and a subscription generated as a part of the purchasing process for Customer accounts to be created or updated accordingly.

Add the CUSTOMERID parameter to a buy link generated using the Sales Links area of the Control Panel. For example, the following link:

https://secure.2checkout.com/order/checkout.php?PRODS=1234567

should be changed to

https://secure.2checkout.com/order/checkout.php?PRODS=1234567&CUSTOMERID=999999a

If the no existing Customer Accounts feature the 999999a identifier, then a new Customer Account will be created using the external reference you specified.

Attribute a subscription to an existing customer 

Aggregate subscriptions under the same Customer account if the products they're associated with are purchased by the same shopper by taking advantage of theCUSTOMERID (case sensitive) parameter added to buy links.

You can use and existing external customer ID for a Customer account already generated in the 2Checkout system to place new orders.

Let's assume that a customer account with the 999999a CUSTOMERID (external customer reference) was already created for one of your shoppers for a previous order. When the same shopper places a new order using the 2Checkout platform, the subscriptions generated will automatically be grouped under the same Customer account provided that the purchase is done using a buy link which features &CUSTOMERID=999999a.

For example, the following link:

https://secure.2checkout.com/order/checkout.php?PRODS=1234999

should be changed to

https://secure.2checkout.com/order/checkout.php?PRODS=1234999&CUSTOMERID=999999a

to ensure that any new subscriptions generated will be aggregated under the existing Customer accounts with the 999999a identifier.

Place orders using the Avangate Customer Reference (ID) AV_CUSTOMERID

The 2Checkout system generates default customer numerical (integer) IDs automatically for all orders containing products that feature subscriptions. Once created, Avangate customer references can be used for new acquisitions aggregating new subscriptions under an existing Customer account.

Note: Avangate customer references are spawned automatically by the 2Checkout system. While you're able to use them to place new orders for existing customers, you can't set your own Avangate customer references. However, you can create and edit External customer references according to your needs. External Customer IDs and Avangate Customer IDs can coexist.

Existing system-generated IDs can serve to group new subscriptions under already created Customer accounts, by using the AV_CUSTOMERID (case sensitive) parameter in the Buy Links for orders.

Assume that a Customer account with the 123456789 AV_CUSTOMERID (internal Avangate customer reference) was already created for one of your shoppers for a previous order. When the same shopper places a new order using the 2Checkout platform, the subscriptions generated will automatically be grouped under the same Customer account provided that the purchase is done using a buy link which features &AV_CUSTOMERID=123456789. All subscriptions generated as a result of this order will automatically be grouped under the customer featuring the 123456789 system generated ID.

Note: AV_CUSTOMERID can only be used for new acquisitions made by existing customers, which have already had an internal Avangate customer reference attributed to them.

If parameters for both an Avangate Customer ID and an External Customer ID are used in the Buy Link for the same order, the internal Avangate customer reference will take precedence over the external identifier (that will be ignored by the system. )

Network Cross-selling

The Customer ID used in the buy link is limited to the customers of the vendor which owns the shopping cart. Subscriptions from third-party 2Checkout vendors will not be associated with the same customer ID as that of the main vendor. 

Overview

Use this object to create new orders and collect payments from shoppers using products with dynamic information. 

Purchase types available are PRODUCT, TAX, SHIPPING, and COUPON. The surcharge defined in the pricing option is used for calculating the order renewal price, when applicable.

You can find a list of common errors that may arise when using the placeOrder call via APIv6 here.

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
3. Free orders (no payment information required).
4. 2Pay.js

How to test?

Place test orders with dynamic product information by following the instructions from this article.

Requirements

The product code must be sent as null. The order currency must match with the payment currency, otherwise, an error is thrown. The isDynamic parameter of the Items object must be true.

For credit card orders placed using API 5.0 or newer versions, you need to pass through additional parameters that support the 3D Secure flow. 3D Secure works by redirecting customers to pages provided by their banks, where they need to enter additional security tokens or passwords to trigger the completion of the charge. By using 3D Secure, you get additional protection from liability for fraudulent card payments, with customers having to go through an extra layer of authentication.

Send the following parameters as part of the PaymentMethod object:

Limitations

Placing an order with both catalog and dynamic product information is not possible. Recurring options can be set only for purchase type PRODUCT and TAX.

For MoR business model, the purchase type can only be PRODUCT and COUPON. 

Parameters

Name

Overview

Use the assignPricingConfigurationOptionGroup method to assign a PricingOption Group to a PricingConfiguration.

Parameters

Response

bool(true)

Request

<?php

require ('PATH_TO_AUTH');

$PricingConfigurationCode = 'YOUR_CODE';
$PriceOptionsGroupAssigned = new stdClass();
$PriceOptionsGroupAssigned->Code = 'USERSUSERS';
$PriceOptionsGroupAssigned->Required = TRUE;

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'assignPricingConfigurationOptionGroup',
'params' => array($sessionID, $PricingConfigurationCode, $PriceOptionsGroupAssigned)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

?>

Overview

Get the price for a product in a new purchase scenario, based on the product ID, the pricing list it's assigned to, and specific pricing options.

Requirements

This method requires you to set a specific partner using setPartner.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');  // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_SET_PARTNER'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner

$productId = 'YOUR_PRODUCT_ID';
$pricingListCode = 'YOUR_PRICING_LIST_CODE';
$priceOptions = array(
'PRICE_OPTION_CODE_1',
'PRICE_OPTION_CODE_2'
);

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getProductPrice',
'params' => array($sessionID, $productId, $pricingListCode, $priceOptions)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

Errors

Overview

Use this object to assign, update, retrieve and delete additional information fields from your subscriptions.

Parameters

Overview

Use the getProposalById method via JSON-RPC APIv6 to retrieve a proposal/quote using a specific ID.

Request Parameters

Request Sample

<?php

require ('PATH_TO_AUTH');

$proposalID = "0573e71d-38bb-4d61-88ca-b3c557517c68";

$jsonRpcRequest = new stdClass();
$jsonRpcRequest->jsonrpc = '2.0';
$jsonRpcRequest->method = 'getProposalById';
$jsonRpcRequest->params = array($sessionID, $proposalID);
$jsonRpcRequest->id = $i++;

try {
    $result = callRPC($jsonRpcRequest, $host);
    echo "Proposal: </br>", 
    var_dump($result);
}
catch (SoapFault $e) {
    echo "Could not fetch proposal: " . $e->getMessage();
    exit;
}

Response

The getProposalById call via JSON-RPC APIv6 returns the Proposal object.

Overview

Pay a partner invoice that was set using setProforma. Works in conjunction with setProforma and setPaymentDetails. Call setProforma, then setPaymentDetails and payProforma in this specific order to pay for a partner invoice.

Requirements

This method requires that a specific partner be set using setPartner.

You also need to use setProforma to mark a partner invoice for payment, and specify the payment method with setPaymentDetails.

Parameters

Response

Request

<?php

require('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/02Authentication
require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner
require('PATH_TO_setProforma'); // setProforma example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/14Billing/00Capture_card_payment/00Set_partner_invoice
require('PATH_TO_setPaymentDetails'); // setPaymentDetails example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/14Billing/00Capture_card_payment/02Set_partner_invoice_payment_details

try {
    $ProformaPay= $client->payProforma($sessionID);
} catch (SoapFault $e) {
    Echo "ProformaPaid: " . $e->getMessage();
    exit;
}
var_dump ("ProformaPaid ", $ProformaPay);

Errors

Overview

Retrieve the account balance from your current payout period, detailed for each billing currency.

You can also search for the historical transfers issued by 2Checkout for your account, and filter the results based on the payment date, method or invoice paid.

Overview

Copy card-on-file data available in the 2Checkout system from a source subscription to an imported target subscription. 2Checkout uses the existing payment information to charge customers as a part of the recurring billing (renewal) process.

Use the copyPaymentInfo method.

Requirements

The imported target subscription and the source subscription must belong to the same customer. The 2Checkout system checks to make sure that the 2Checkout Customer Reference (an internal identifier) coincides with the customer accounts associated with the target and source subscriptions.

Availability

Please contact 2Checkout directly if you wish to take advantage of this feature.

How does this method work?

1. Customer A purchases Subscription A using a VISA credit card and you import Subscription B for the same customer with no data or with an AMEX card.
2. When 2Checkout renews Subscription A, it charges Customer A using the VISA, while using the AMEX (if the data was provided) for Subscription B charges.
3. When you copy the payment data from Subscription A to Subscription B, the 2Checkout system uses the VISA credit card to renew both subscriptions according to their respective recurring billing cycles. 2Checkout charges customers during the recurring billing process for the imported target subscription using the payment method they used to purchase the source subscription.

Parameters

Response

Request

<?php

require ('PATH_TO_AUTH');

$TargetSubscription = 'FFAE3C9429';
$SourceSubscription = '9F4154733C';

try {
    $payInfo = $client->copyPaymentInfo($sessionID, $TargetSubscription, $SourceSubscription);
}
catch (SoapFault $e) {
    echo "payInfo: " . $e->getMessage();
    exit;
}
var_dump("payInfo", $payInfo);

Overview 

1. Working code samples for JSON-RPC and SOAP are available in PHP for each documented method, including the clients you need to make API calls. You need to replace the dummy Merchant Code and Secret Key with those available in your Merchant Control Panel.
2. Working code samples for REST are available for each documented scenario and method. Check out the REST reference for examples. To access code samples, select any scenario and click on the "Working example" link. Working code samples:

• cURL
• Java
• JavaScript
• Node.js
• Perl
• Python
• PHP
• Ruby
• Go
• C#
• Visual Basic
• Groovy
• Objective-C
• Swift