| Verifone Developer Portal

Retrieve price matrix for product

Overview

Use the GetPriceMatrix API call to retrieve details that are used to add or update a special price promotion.

Request parameters

Paremeters	Type	Required	Description
sessionID	String	Required	The unique identifier of the session.
PriceMatrixRequest	Array of Objects	Required	Contains details that are used to add or update a special price promotion.
PriceMatrixRequestObject	Object	Required
ProductCode	String	Required	Product code for the price matrix.
PricingConfigurationCode	String	Required	Pricing configuration code for the price matrix, must be related to the product.

Response

Parameters	Type	Description
PriceMatrix	Array of Objects	Only for this type of promotion. It is generated by getPriceMatrix and used to set promotion special prices.
ProductCode	String	Product code for the price matrix.
PricingConfigurationCode	String	Pricing configuration code for the price matrix, must be related to the product.
OptionHash	String	Unique identifier of one combination of price configuration options.
Options	Array of objects	Describes price configuration options identified by OptionHash.
GroupName	String
OptionText	String
Prices	Array of Objects	Promotion prices by currency, price for default currency is required.
Value	Int	Decimal.
Currency	String	ISO currency code.

Request sample

<?php

require('PATH_TO_AUTH');


$priceMatrixRequestObject1 = new stdClass;
$priceMatrixRequestObject1->productCode = "474FF7C0FD"
$priceMatrixRequestObject1->pricingConfigurationCode = "514EE48419"

$requestBody = [
    $priceMatrixRequestObject1
]

$promotionObject->PriceMatrix = [$priceMatrixDefinition1];


$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getPriceMatrix',
'params' => array($sessionID, $requestBody),
);

$result = callRPC((object)$jsonRpcRequest, $host);
var_dump($result);

Affiliate marketing: 5 myths debunked

The performance marketing industry started in 1994 when 3rd party "affiliates" joined the marketing mix advertising pioneers of eCommerce on a pay-for-performance basis. There's been a lot of changes over the last 20 years and affiliate marketing has created a reputation for itself - for better or worse.

Hear Rick Gardiner, CEO of Affiliate Management as he highlights some of the major changes in affiliate marketing and shares insight on 5 common misconceptions around working with affiliates including forecasting, cross-channel cannibalization, and more.

Add product

Overview

Use the addProduct method to create subscription plans/products for your 2Checkout account.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
Product	Required (object)
	Use this object to configure your subscription plans/products. You can set all Product parameters except 2CheckoutID and GroupName. The 2Checkout system sets the unique product ID. The 2CheckoutID and GroupName are not editable.

Mandatory parameters

ProductName
ProductCode
PricingConfigurations

Response

bool(true)

Sample request

<?php
 
require ('PATH_TO_AUTH'); // authentication call
 
$Product = new stdClass();
$Product->2CheckoutId = null;
$Product->ProductCode = 'API_Imported_Product_1';
$Product->ProductType = 'REGULAR';
$Product->ProductName = 'API_Subscription Imported New';
$Product->ProductVersion = '1.0';
 
$Product->GiftOption = false;
$Product->ShortDescription = 'Placeat cumque necessitatibus est minus praesentium ut non quibusdam. Molestias provident tempore eligendi mollitia quia.';
$Product->LongDescription = 'Corrupti inventore vitae nesciunt ab. Nemo cum non maiores. Non repudiandae est iste voluptatibus.';
$Product->SystemRequirements = null;
$Product->ProductCategory = null;
$Product->Platforms = array();
$Product->Platforms[0] = new stdClass();
$Product->Platforms[0]->PlatformName = null;
$Product->Platforms[0]->Category = null;
$Product->Platforms[1] = new stdClass();
$Product->Platforms[1]->PlatformName = null;
$Product->Platforms[1]->Category = null;
$Product->ProductImages = array();
$Product->ProductImages[0] = new stdClass();
$Product->ProductImages[0]->URL = null;
$Product->ProductImages[0]->Default = false;
$Product->ProductImages[1] = new stdClass();
$Product->ProductImages[1]->URL = null;
$Product->ProductImages[1]->Default = true;
$Product->TrialUrl = null;
$Product->TrialDescription = null;
$Product->Enabled = True;
 
//Product additional fields
 
/* $Product->AdditionalFields = array();
$Product->AdditionalFields[0] = new stdClass();
$Product->AdditionalFields[0]->Label = 'i44wak1dzp';
$Product->AdditionalFields[0]->Code = 'ITYAK0OEWJ';
$Product->AdditionalFields[0]->Enabled = false;
$Product->AdditionalFields[0]->Required = false;
$Product->AdditionalFields[0]->URLParameter = 'id1ktigl6d';
$Product->AdditionalFields[1] = new stdClass();
$Product->AdditionalFields[1]->Label = 'aig699lmo1';
$Product->AdditionalFields[1]->Code = 'V28TP07PQN';
$Product->AdditionalFields[1]->Enabled = false;
$Product->AdditionalFields[1]->Required = true;
$Product->AdditionalFields[1]->URLParameter = '8to9p6y54j'; */
 
//Product localization
 
/* $Product->Translations = array();
$Product->Translations[0] = new stdClass();
$Product->Translations[0]->Name = 'zsg7wtg4e5';
$Product->Translations[0]->Description = 'Voluptate iure ut quam omnis impedit. Deserunt facere id dolores doloribus quis. Minima nostrum ut possimus incidunt vel est sint. Odit tempora omnis iste nesciunt commodi accusantium placeat.';
$Product->Translations[0]->Language = 'pt';
$Product->Translations[0]->LongDescription = 'Pariatur molestiae sit dignissimos modi. Aut modi libero numquam repudiandae. Doloribus explicabo delectus fugiat amet. Excepturi quo consequatur sint adipisci.';
$Product->Translations[0]->SystemRequirements = 'c16tvyg88c';
$Product->Translations[0]->TrialUrl = 'UNCAUGHT TYPE: anyURI';
$Product->Translations[0]->TrialDescription = 'Voluptas rem sit ut voluptas molestias quidem ut. Maiores facilis tempora voluptates. Consequuntur illum recusandae hic magni iste.';
$Product->Translations[1] = new stdClass();
$Product->Translations[1]->Name = 'cv2sx15aby';
$Product->Translations[1]->Description = 'Ut distinctio asperiores et a placeat voluptatem et. Et eveniet temporibus aut vel. Nemo occaecati praesentium dolor fugiat rerum assumenda expedita.';
$Product->Translations[1]->Language = 'fr';
$Product->Translations[1]->LongDescription = 'Et ut nostrum molestiae voluptates soluta. Molestiae cum in ut qui. Voluptatem voluptates vero odit quia corporis. In impedit eligendi sed expedita nihil temporibus nobis.';
$Product->Translations[1]->SystemRequirements = 'cfv2amk25j';
$Product->Translations[1]->TrialUrl = 'UNCAUGHT TYPE: anyURI';
$Product->Translations[1]->TrialDescription = 'Voluptatem ut possimus consequatur iste. Recusandae id quia sed quibusdam aut debitis. Cupiditate harum architecto quod quia.'; */
 
 
$Product->PricingConfigurations = array();
$Product->PricingConfigurations[0] = new stdClass();
$Product->PricingConfigurations[0]->Default = false;
$Product->PricingConfigurations[0]->Code = null;
$Product->PricingConfigurations[0]->Name = 'API Pricing Configuration Test';
$Product->PricingConfigurations[0]->BillingCountries = array();
$Product->PricingConfigurations[0]->PricingSchema = 'DYNAMIC';
$Product->PricingConfigurations[0]->PriceType = 'NET';
$Product->PricingConfigurations[0]->DefaultCurrency = 'USD';
$Product->PricingConfigurations[0]->Prices = new stdClass();
$Product->PricingConfigurations[0]->Prices->Regular = array();
$Product->PricingConfigurations[0]->Prices->Regular[0] = new stdClass();
$Product->PricingConfigurations[0]->Prices->Regular[0]->Amount = 100;
$Product->PricingConfigurations[0]->Prices->Regular[0]->Currency = 'USD';
$Product->PricingConfigurations[0]->Prices->Regular[0]->MinQuantity = 1;
$Product->PricingConfigurations[0]->Prices->Regular[0]->MaxQuantity = 10;
$Product->PricingConfigurations[0]->Prices->Regular[0]->OptionCodes = array();
$Product->PricingConfigurations[0]->Prices->Regular[1] = new stdClass();
$Product->PricingConfigurations[0]->Prices->Regular[1]->Amount = 200;
$Product->PricingConfigurations[0]->Prices->Regular[1]->Currency = 'USD';
$Product->PricingConfigurations[0]->Prices->Regular[1]->MinQuantity = 11;
$Product->PricingConfigurations[0]->Prices->Regular[1]->MaxQuantity = 100;
$Product->PricingConfigurations[0]->Prices->Regular[1]->OptionCodes = array();
$Product->PricingConfigurations[0]->Prices->Renewal = array();
$Product->PricingConfigurations[0]->Prices->Renewal[0] = new stdClass();
$Product->PricingConfigurations[0]->Prices->Renewal[0]->Amount = 50;
$Product->PricingConfigurations[0]->Prices->Renewal[0]->Currency = 'USD';
$Product->PricingConfigurations[0]->Prices->Renewal[0]->MinQuantity = 1;
$Product->PricingConfigurations[0]->Prices->Renewal[0]->MaxQuantity = 10;
$Product->PricingConfigurations[0]->Prices->Renewal[0]->OptionCodes = array();
$Product->PricingConfigurations[0]->Prices->Renewal[1] = new stdClass();
$Product->PricingConfigurations[0]->Prices->Renewal[1]->Amount = 60;
$Product->PricingConfigurations[0]->Prices->Renewal[1]->Currency = 'USD';
$Product->PricingConfigurations[0]->Prices->Renewal[1]->MinQuantity = 11;
$Product->PricingConfigurations[0]->Prices->Renewal[1]->MaxQuantity = 100;
$Product->PricingConfigurations[0]->Prices->Renewal[1]->OptionCodes = array();
$Product->PricingConfigurations[0]->PriceOptions = array();
 
/* $Product->BundleProducts = array();
$Product->BundleProducts[0] = new stdClass();
$Product->BundleProducts[0]->ProductCode = '540Q45PQBN';
$Product->BundleProducts[0]->ProductId = 48439;
$Product->BundleProducts[1] = new stdClass();
$Product->BundleProducts[1]->ProductCode = 'PA3JDB5SZ2';
$Product->BundleProducts[1]->ProductId = 46439;
 */
$Product->Fulfillment = 'NO_DELIVERY';
$Product->Prices = array();
 
$Product->GeneratesSubscription = True;
$Product->SubscriptionInformation = new stdClass();
$Product->SubscriptionInformation->DeprecatedProducts = array();
$Product->SubscriptionInformation->BundleRenewalManagement = null;
$Product->SubscriptionInformation->BillingCycle = 1;
$Product->SubscriptionInformation->BillingCycleUnits = 'M';
$Product->SubscriptionInformation->IsOneTimeFee = false;
 
$Product->SubscriptionInformation->ContractPeriod = new stdClass();
$Product->SubscriptionInformation->ContractPeriod->Period = -1;
$Product->SubscriptionInformation->ContractPeriod->PeriodUnits = 'days';
$Product->SubscriptionInformation->ContractPeriod->IsUnlimited = TRUE;
$Product->SubscriptionInformation->ContractPeriod->Action = 'RESTART';
$Product->SubscriptionInformation->ContractPeriod->EmailsDuringContract = 'altenwerth.elise@gmail.com';
 
//$Product->SubscriptionInformation->UsageBilling = 77;
 
$Product->SubscriptionInformation->GracePeriod = new stdClass();
$Product->SubscriptionInformation->GracePeriod->Type = 'GLOBAL';
$Product->SubscriptionInformation->GracePeriod->Period = 14;
$Product->SubscriptionInformation->GracePeriod->PeriodUnits = 'D';
$Product->SubscriptionInformation->GracePeriod->IsUnlimited = false;
 
$Product->SubscriptionInformation->RenewalEmails = new stdClass();
$Product->SubscriptionInformation->RenewalEmails->Type = 'CUSTOM';
$Product->SubscriptionInformation->RenewalEmails->Settings = new stdClass();
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal = new stdClass();
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->Before30Days = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->Before15Days = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->Before7Days = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->Before1Day = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->OnExpirationDate = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->After5Days = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->ManualRenewal->After15Days = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal = new stdClass();
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->Before30Days = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->Before15Days = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->Before7Days = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->Before1Day = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->OnExpirationDate = true;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->After5Days = false;
$Product->SubscriptionInformation->RenewalEmails->Settings->AutomaticRenewal->After15Days = true;
 
$Product->FulfillmentInformation = new stdClass();
$Product->FulfillmentInformation->IsStartAfterFulfillment = false;
$Product->FulfillmentInformation->IsElectronicCode = false;
$Product->FulfillmentInformation->IsDownloadLink = false;
$Product->FulfillmentInformation->IsBackupMedia = false;
$Product->FulfillmentInformation->IsDownloadInsuranceService = false;
$Product->FulfillmentInformation->IsInstantDeliveryThankYouPage = false;
$Product->FulfillmentInformation->IsDisplayInPartnersCPanel = false;
 

try {
    $NewSubscriptionPlan = $client->addProduct($sessionID, $Product);
}

catch (SoapFault $e) {
    echo "AddedProductInfo: " . $e->getMessage();
    exit;
}
var_dump("AddedProductInfo", $NewSubscriptionPlan);
?>

Extend a subscription

Overview

Extend the lifetime of a subscription in the 2Checkout system on-demand. Use the extendSubscription method to set a new expiration deadline for a subscription.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
subscriptionReference	Required (string)
	Unique, system-generated subscription identifier.
days	Required (int)
	2Checkout prolongs the lifetime of a subscription using the number of days you send, adding the interval on top of the expiration date. Hint: Use a negative number to reduce the lifetime of a subscription. Cannot be NULL.

Response

Parameters	Type/Description
Boolean	true or false depending on whether the changes were successful or not.

Request

<?php

require ('PATH_TO_AUTH');

$subscriptionReference = 'YOUR_SUBSCRIPTION_REFERENCE';
$days = 5;

$jsonRpcRequest = array (
'method' => 'extendSubscription',
'params' => array($sessionID, $subscriptionReference, $days),
'id' => $i++,
'jsonrpc' => '2.0');

var_dump (callRPC((Object)$jsonRpcRequest, $host, true));

SimplePricingList Object Structure

Parameters

Parameter	Type/Description
PricingListCode	String
	The unique identifier of the pricing list.
Name	String
	The name of the pricing list.

Retrieve a pricing configuration by code

Overview

Use the getPricingConfigurationByCode method to extract information on a specific pricing configuration you set for a product.

Parameters

Parameters	Type/Description
sessionID	Required (string)
	Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect. The sessionID expires in 10 minutes.
productCode	Required (string)
	The editable code that you control at product-level, not the unique, system-generated product ID.
pricingConfigurationCode	Required (string)
	The code of the pricing configuration.

Response

Parameters	Type/Description
PricingConfiguration	Object

Request

<?php

require ('PATH_TO_AUTH');

$productCode = 'YOUR_PRODUCT_CODE';
$pricingConfigurationCode = 'YOUR_PRICING_CONFIGURATION_CODE';

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getPricingConfigurationByCode',
'params' => array($sessionID, $productCode, $pricingConfigurationCode)
);
var_dump (callRPC((Object)$jsonRpcRequest, $host));

?>

Orders with installments

Overview

2Checkout supports local Brazilian Visa, MasterCard and AMEX credit/debit cards limited to national purchases in the local currency BRL (Brazilian Real).

Requirements

Installments are available only for:
- Brazilian customers
- Local Visa, MasterCard or AMEX cards
- Non-recurring transactions
Minimum installment threshold is 5 BRL. The maximum number of installments is 6.
Mandatory information for payments also includes shopper phone number and Fiscal Code (CPF/CNPJ).

Do local BR cards with/without installments require an addendum to my contract?

Yes. Please contact 2Checkout for activation.

How does it work?

Create the Order object.
Validate the number of installments available based on total order value.
Place the order specifying the number of installments.

Funds collection for installment payments

2Checkout pays you in full, regardless of the number of installments (this is covered directly by the banks).

Single Sign On (SSO)

Overview

Redirect and login shoppers automatically from your user portal into their 2Checkout myAccount based on subscription or customer information.

Requirements

You need a custom domain to use Single Sign-On. Contact 2Checkout directly for guidance on how to set up a custom domain.

Order information object

Overview

Use this object to retrieve information about orders.

Attributes

Parameters

Type/Description

RefNo

Optional (string)

Avangate generates unique reference numbers for all orders (purchases). You can use this parameter to retry authorizations for orders with failed transactions by changing the payment method.

NULL when you place new orders.

OrderNo

Optional (string)

The consecutive order number Avangate associates with orders and displays in the Order search area of your account.

ExternalReference

Optional (string)

Set external reference identifiers for orders. Enables you to replicate the functionality of the REF parameter included into Buy Links. Maximum 100 characters. If there is a need for longer references, you can apply an md5 hash for any string value, resulting in a 32 characters string. You can verify the hash after the order notification, on the client side.

ShopperRefNo

Optional (string)

External shopper identifier.

Status

Optional (string)

The status of the order:

AUTHRECEIVED – Avangate blocks the amount corresponding to the transaction, but the process of collecting funds is incomplete.
PENDING - Avangate has yet to block the amount corresponding to the transaction or shoppers used an offline payment method like wire transfer.
COMPLETE – The shopper completed the transaction for the purchase and Avangate or you fulfilled the order (when required).
CANCELED – Avangate cancels orders for which shoppers fail to transfer funds in due time.
REVERSED – Avangate reverses order transactions that never reach the Complete/Finished stage. Shoppers never complete transactions for such purchases.
REFUND – Avangate refunds orders only after they reach the Complete/Finished stage and returns the funds collected to shoppers.

ApproveStatus

Optional (string)

The status of the order resulted from the evaluation by the Avangate anti-fraud system or by a member of the anti-fraud department. This status varies for new purchases and for orders requiring customers to make manual payments.

Possible values:

WAITING: The Avangate anti-fraud system or a member of the anti-fraud department has yet to approve the order.
OK: The Avangate anti-fraud system or a member of the anti-fraud department approved the order.
INVALIDDATA: Shopper-supplied data is invalid – Avangate did not approve the order.
FRAUD: The order is fraudulent.

VendorApproveStatus

Optional (string)

Shows if you approved or not a partner order. Possible values:

OK
WAITING
REJECTED

Language

Optional (string)

ISO 639-1 two-letter code. Language used for the purchase process. Example: “en.”

OrderDate

Optional (string)

Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when customers place their orders.

FinishDate

Optional (string)

Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when the order reach the Complete status.

NULL for order that did not reach the Complete/Finished stage.

Source

Optional (string)

The link source for the sales. Enables you to replicate the functionality of the SRC (separate link identifier) parameter when included into Buy Links. Use the SRC parameter to track sale sources.

Maximum length 255 characters. Cannot be null.

AffiliateSource

Optional (string)

The link source for affiliate referred sales. Similar to the functionality of the SRC (separate link identifier) parameter included into Buy Links, but controlled by the AFFSRC parameter. Affiliates use the AFFSRC parameter to track sale sources for their referrals. Maximum length 255 characters.

AffiliateId

Optional (int)

Identifier belonging to affiliates who refer orders.

AffiliateName

Optional (string)

Affiliate name.

AffiliateUrl

Optional (string)

Affiliate website URL from the Affiliate Details.

RecurringEnabled

Optional (boolean)

true or false, depending on whether the shoppers checked the subscription auto-renewal checkbox or not, during the purchase process.

HasShipping

Optional (boolean)

true or false, depending on whether the order requires shipping.

BillingDetails

Optional (Object)

Details below.

Person

Object

Details below.

FirstName

Optional (string)

Shopper name.

LastName

Optional (string)

Shopper surname.

CountryCode

Optional (string)

Shopper country. ISO 3166 two-letter code.

State

Optional (string) – Required for US, Brazil, India and Romania

The state in the shopper's country. Mandatory when you set the Billing Country to US, Brazil, India and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.

City

Optional (string)

Shopper city.

Address1

Optional (string)

Shopper address.

Address2

Optional (string)

Shopper address.

Zip

Optional (string)

ZIP/ Postal code.

Email

Optional (string)

Shopper email address.

Phone

Optional (string)

Shopper phone number. Mandatory when you set Brazil as the Billing Country. Can be NULL.

Company

Optional (string)

Company name. Can be null for end users. When present, you also need to provide the FiscalCode.

FiscalCode

Optional (string) – Required for Brazil

• For companies, it needs to be the VAT ID. Avangate will validate the value provided and throw an error if the VAT ID is invalid/incorrect when calling setPaymentDetails. When present, you also need to provide the Company name.

• Mandatory when the Billing Country is set to Brazil. For Brazilian customers it represents the Fiscal Code (CPF/CNPJ).

• Mandatory when the Billing Country is set to India, and purchase is made by a Company.

• Can be null for end users.

DeliveryDetails

Optional (Object)

Optional. When missing, Avangate uses the same details as for the BillingDetails object.

Details below.

Person

Object

Details below.

FirstName

Optional (string)

Shopper name from the delivery details.

LastName

Optional (string)

Shopper surname from the delivery details.

CountryCode

Optional (string)

Shopper country. ISO 3166 two-letter code from the delivery details.

State

Optional (string) – Required for US, Brazil and Romania

The state in the shopper's country from the delivery details. Mandatory when you set the Billing Country to US, Brazil and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.

City

Optional (string)

Shopper city from the delivery details.

Address1

Optional (string)

Shopper address from the delivery details.

Address2

Optional (string)

Shopper address from the delivery details.

Zip

Optional (string)

ZIP/ Postal code from the delivery details.

Email

Optional (string)

Shopper email address from the delivery details.

Phone

Optional (string)

Shopper phone number from the delivery details. Mandatory when you set Brazil as the Billing Country. Can be NULL.

Company

Optional (string)

Company name from the delivery details. Can be null for end users. When present, you also need to provide the FiscalCode.

PaymentDetails

Optional (Object)

Adapt this object to the desired payment method.

Type

Optional (string)

The payment method:

CC (credit/debit card - including local Brazilian cards).
PAYPAL
PAYPAL_EXPRESS
TEST (for test orders).
PREVIOUS_ORDER (place new orders using the reference of a previous order).
EXISTING_PAYMENT_DATA (use a card one of your customers already used to purchase from your account).
WIRE – the placeOrder response includes Wire payment details.
CHECK – the placeOrder response includes Check payment details.
PURCHASEORDER - use for orders with POs.
FREE – for 0 value orders for which you’re not requiring customers to provide payment details.

Currency

Optional (string)

The currency ISO code for the payment - ISO 4217. Example: “usd.”

PaymentMethod

Optional (object)

Object structure and parameters differ according to payment method selected and API method (placing orders (POST) vs. retrieving order data (GET)). For payments with credit cards, PalPay Express, previous order reference and purchase order use the objects below.

For payments with check and wire, send only the ‘CHECH’ and ‘WIRE’ strings.

null for 0 value orders for which you’re not requiring customers to enter payment details.

PaymentDetailsCard

Optional (object)

Details below.

CardType

Optional (string)

visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo

FirstDigits

Optional (string)

First four digits of the credit card.

LastDigits

Optional (string)

Last four digits of the credit card.

CheckPaymentDetails

Optional (Object)

Details below.

Beneficiary

Optional (string)

The beneficiary of the payment.

Can be NULL.

CheckPostalAddress

Optional (string)

The address of the beneficiary.

Can be NULL.

Amount

Optional (double)

The total costs incurred by the customer for an order.

Can be NULL.

Currency

Optional (string)

The currency ISO code of the order/payment - ISO 4217.

Can be NULL.

PayPalExpress

Optional (Object)

Details below.

Email

Optional (string)

Email address customers use for their PayPal account.

ReturnURL

Optional (string)

The PayPal Express Checkout redirect URL returned by calling the getPayPalExpressCheckoutRedirectURL method. The return URL is the page on your website to which PayPal redirects your buyer's browser after the buyer logs into PayPal and approves the payment. Typically, this is a secure page (https://...) on your site.

CancelURL

Optional (string)

The cancel URL is the page on your website to which PayPal redirects your buyer's browser if the buyer does not approve the payment. Typically, this is the secure page (https://...) on your site from which you redirected the buyer to PayPal.

WirePaymentDetails

Optional (Object)

Details below.

Amount

Optional (double)

The total costs customers incur.

Can be NULL.

Currency

Optional (string)

The currency ISO code of the order - ISO 4217.

Can be NULL.

PaymentReference

Optional (string)

Transaction identifier.

Can be NULL.

RoutingNumber

Optional (string)

Identification number assigned to financial institutions.

Can be NULL.

BankAccounts

Optional (Array of objects)

Details below.

Beneficiary

Optional (string)

The beneficiary of the payment.

Can be NULL.

BankName

Optional (string)

The name of the beneficiary's bank.

Can be NULL.

BankCountry

Optional (string)

The country of the beneficiary's bank.

Can be NULL.

BankCity

Optional (string)

The city of the beneficiary's bank.

Can be NULL.

BankAddress

Optional (string)

The address of the beneficiary's bank.

Can be NULL.

BankAccount

Optional (string)

The number for the account in which customers transfer the funds.

Can be NULL.

BankAccountIban

Optional (string)

The IBAN of the beneficiary's bank.

Can be NULL.

BankAccountSwiftCode

Optional (string)

The Swift Code of the beneficiary's bank.

Can be NULL.

Currency

Optional (string)

The currency ISO code for the bank account - ISO 4217.

Can be NULL.

CustomerIP

Optional (string)

Shopper IP.

CustomerDetails

Object

Avangate populates the parameters of the customer entity with information from the customer whose AvangateCustomerReference or ExternalCustomerReference you send during the purchase.

Details below.

AvangateCustomerReference

Optional (Int)

System-generated Avangate customer reference. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the AV_CUSTOMERID (case sensitive) parameter to buy links. The Avangate system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions.

ExternalCustomerReference

Optional (string)

The external customer reference you control. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the CUSTOMERID (case sensitive) parameter to buy links.

FirstName

Optional (string)

Customer's first name.

LastName

Optional (string)

Customer's last name.

CountryCode

Optional (string)

Customer's country code (ISO 3166 two-letter code).

State

Optional (string)

Customer's state. For example, "Alabama","Alaska","Arizona".

City

Optional (string)

Customer's city.

Address1

Optional (string)

Customer's address.

Address2

Optional (string)

Customer's address.

Zip

Optional (string)

Zip code.

Email

Optional (string)

Customer's email.

Phone

Optional (string)

Customer's phone number.

Company

Optional (string)

Company name.

FiscalCode

Optional (string)

For companies, it needs to be the VAT ID. Avangate validates this values and throws an error if the VAT ID is invalid/incorrect. When present, you need to also provide Company name.

Can be null for end users.

Fax

Optional (string)

Customer's fax number.

Enabled

Optional (boolean)

true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription.

Trial

Optional (boolean)

true or false, depending on whether the customer account features only trials or also paid subscriptions.

Language

Optional (string)

ISO 639-1 two-letter code. Example: “en.”

ExistingCards

Optional (Array of objects)

Details below.

TransientToken

Optional (Object)

Populated only when you retrieve customer information by SSOToken.

Token

Optional (string)

Token for the EXISTING_PAYMENT_DATA flow. Use it to charge customers using cards they used in the past for purchases from your Avangate account.

CardType

Optional (string)

visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo

LastDigits

Optional (string)

Last four digits of the credit card.

ExpirationMonth

Optional (string)

Card expiration month.

ExpirationYear

Optional (string)

Card expiration year.

NameOnCard

Optional (string)

Card holder name.

Origin

Optional (String)

Avangate automatically tracks the source of purchases:

Web – When customers use the desktop version of the Avangate shopping cart.
API - When customers use a custom, API-based ordering interface.
Mobile - When customers use the mobile version of the Avangate shopping cart.
Automatic Billing – For auto-renewals and trial conversions.

AvangateCommission

Optional (Int)

Avangate's commission for the order.

OrderFlow

Optional (string)

PURCHASE_ORDER - Sent only when shoppers used Purchase Orders.

REGULAR - Sent in all other cases.

GiftDetails

Optional (object)

Contains contact details for the recipient of a gift purchase.

FirstName

Optional (string)

First name of gift recipient.

LastName

Optional (string)

Last name of gift recipient.

Email

Optional (string)

Email of gift recipient. Avangate uses this email for the delivery/fulfillment process.

GiftNote

Optional (string)

Custom text shoppers provide as a message to the gift recipient.

PODetails

Object (optional)

Details below.

Status

Optional (string)

PO status. Possible values:

PO status API	PO status cPanel
AWAITING_UPLOAD	Awaiting form submission - Waiting for the customer to submit the PO form
TIME_EXPIRED	Expired, form not received - The customer did not submit the PO form
AWAITING_MERCHANT	Awaiting your confirmation - PO approved by Avangate, awaiting vendor confirmation
MERCHANT_TIME_EXPIRED	Expired, PO not confirmed - You didn't confirm/reject the PO
AWAITING_MERCHANT	Rejected - You rejected the PO
AWAITING_PAYMENT	Awaiting payment - You approved the PO, waiting for payment
AWAITING_PAYMENT	Expired, not paid - The customer did not complete the PO payment. Avangate accepts payments up to 30 days after the PO payment interval expires
NOT_PAID	Canceled, not paid - The customer did not complete the PO payment
NOT_PAID	Canceled by Avangate - Avangate canceled the PO
NOT_PAID	Canceled via API - You canceled the PO (via API)
PAID	Complete - Customer paid the PO. The order is complete

AutoApprove

Optional (Boolean)

TRUE or FALSE, depending on whether you set POs to auto-approve or not.

ExtraInformation

Optional (Object)

Details below.

PaymentLink

Optional (String)

Can be:

1. The PO doc upload link - If you set AutoApprove as FALSE on the original order and before shoppers upload the PO.

2. Payment link for orders with POs. Business customers can use the PaymentLink to finalize payment for orders with POs. If you set AutoApprove as TRUE on the original order and if Avangate and you approve the PO.

PaymentLink

Optional (string)

In scenarios in which an issue blocks the transaction from finalizing, Avangate provides a retry link where shopper can complete their purchase by providing new payment details.

PartnerCode

Optional (string)

Partner code you configured for your partner. NULL for eStore orders.

PartnerMargin

Optional (double)

Partner margin you set for the order. NULL for eStore orders.

PartnerMarginPercent

Optional (double)

The percentage of the partner margin from the net value of the products ordered, minus the value of any discounts. NULL for eStore orders.

ExtraMargin

Optional (double)

Extra margin you offer by editing partner orders. NULL for eStore orders.

ExtraMarginPercent

Optional (double)

The percentage of the extra partner margin from the net value of the products ordered, minus the partner margin and the value of any discounts. NULL for eStore orders.

ExtraDiscount

Optional (double)

Extra discount you offer by editing partner orders. NULL for eStore orders.

ExtraDiscountPercent

Optional (double)

The percentage of the partner margin from the net value of the products ordered, minus the value of any coupon discounts. NULL for eStore orders.

LocalTime

Optional (string)

Local shopper time in the following format: Y-m-d H:i:s.

This parameter can impact the fraud score of an order when it's missing, NULL or incorrectly formatted.

TestOrder

Optional (Boolean)

True for test orders. False of regular orders.

Errors

Optional (StringArray)

Payment gateway processing errors.

Items

Array of objects

Details below.

ProductDetails

Object

Name

Optional (string)

Product name.

ExtraInfo

Optional (string)

The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.

RenewalStatus

Optional (boolean)

true for orders renewing subscriptions.
false for all other orders: new purchases, upgrades.

Subscriptions

Object

SubscriptionReference

Optional (string)

Unique, system-generated subscription identifier.

PurchaseDate

Optional (string)

The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the Avangate system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.

e.g. 2015-08-11 15:18:52

SubscriptionStartDate

Optional (string)

Example: 2015-09-29 17:57:59

ExpirationDate

Optional (string)

The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings.

Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.

e.g. 2015-09-11 15:18:52

Lifetime

Optional (boolean)

true – For non-recurring, evergreen subscriptions.
false – For recurring subscriptions with a specific billing cycle from 7 days to 36 months.

Trial

Optional (boolean)

true – For trial subscriptions.
false – For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.

Enabled

Optional (boolean)

true – For active and past due subscriptions.
false – For expired and cancelled subscriptions.

RecurringEnabled

Optional (boolean)

PriceOptions

Optional (array of strings)

Array of price option codes.

Code

Optional (strings)

Unique code that the Avangate system generates or that you set for each pricing options group.

Required

Optional (boolean)

true – you require shoppers to select the price option through the way in which you configured pricing.
false – you do not require shoppers to select the price option.

Options

Optional (array of strings)

The code you set or that the Avangate system generates for each price option child inside a pricing options group parent.

Price

Object

This object returns the price per unit at order line level.

In the case of trials, the object returns the costs for the trial to full subscription conversion.

UnitNetPrice

Optional (double)

The value per product unit, excluding sales tax/VAT expressed in the payment currency.

UnitGrossPrice

Optional (double)

Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.

UnitVAT

Optional (double)

Sales tax/VAT per product unit expressed in the payment currency.

UnitDiscount

Optional (double)

Value of the discount per product unit expressed in the payment currency.

UnitNetDiscountedPrice

Optional (double)

The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which Avangate deducts the unit discount.

UnitGrossDiscountedPrice

Optional (double)

Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.

UnitAffiliateCommission

Optional (double)

Value of the affiliate commission per product unit calculated expressed in the payment currency.

Avangate deducts discounts from the costs incurred by shoppers before calculating affiliate commissions.

Avangate does not take into account shipping costs when calculating affiliate commissions.

NULL when Avangate does not apply an affiliate commission.

Currency

Optional (string)

The currency ISO code for the payment - ISO 4217. Example: usd.

NetPrice

Optional (double)

The value per order line, excluding sales tax/VAT expressed in the payment currency.

GrossPrice

Optional (double)

Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.

NetDiscountedPrice

Optional (double)

The NetPrice value per order line (in the payment currency), excluding sales tax/VAT, from which Avangate deducts discounts.

GrossDiscountedPrice

Optional (double)

Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.

Example:

UnitNetPrice: 99
UnitGrossPrice: 120.39
UnitVAT: 21.39
UnitDiscount: 9.9
UnitNetDiscountedPrice: 89.1
UnitGrossDiscountedPrice: 110.49
UnitAffiliateCommission: 22.28
Currency: "usd"
NetPrice: 198
GrossPrice: 240.77
NetDiscountedPrice: 178.2
GrossDiscountedPrice: 220.97
Discount: 19.8
VAT: 42.77
AffiliateCommission: 44.56

Discount

Optional (double)

Value of the discounts per order line expressed in the payment currency.

VAT

Optional (double)

Value of sales tax/VAT per order line expressed in the payment currency.

AffiliateCommission

Optional (double)

Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.

Code

Optional (string)

Unique product identifier your control. Max length 256 characters.

Quantity

Optional (integer)

Number of units

SKU

Optional (string)

SKU identifier.

CrossSell

Optional (Object)

Details below.

ParentCode

Optional (string)

The product code of the master product you set to trigger the campaign.

CampaignCode

Optional (string)

Unique, system-generated identifier for cross-sell campaigns.

Trial

Optional (Object)

Details below.

Period

Optional (integer)

The length of the trial subscription lifetime in days.

GrossPrice

Optional (double)

Total trial price in the payment currency before Avangate deducts any taxes, discounts, etc.

VAT

Optional (double)

The total value of taxes for the trial in the payment currency, before Avangate deducts any discounts.

NetPrice

Optional (double)

Total trial price in the payment currency, not including taxes, before Avangate deducts any discounts.

AdditionalFields

Optional (array of objects)

Details below.

Code

Optional (string)

The alpha-numeric characters, underscores and dashes that are set as the field identifier.

Text

Optional (string)

Field text visible to shoppers in the cart.

Value

Optional (string)

Selected field value.

Promotion

Optional (object)

Details below.

Name

Optional (string)

Promotion name.

Description

Optional (string)

Promotion description.

StartDate

Optional (string)

The date when you set the promotion to start. NULL for promotions that start immediately after you create them.

EndDate

Optional (string)

The date when you set the promotion to end. NULL for promotions you want active indefinitely.

MaximumOrdersNumber

Optional (integer)

Avangate only applies the promotion to a maximum number of orders you define.

Can be NULL if you want the promotion to apply to an unlimited number of orders.

MaximumQuantity

Optional (integer)

Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.

InstantDiscount

Optional (boolean)

The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.

Coupon

Optional (string)

Promotion coupon/voucher.

DiscountLabel

Optional (string)

Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.

Enabled

Optional (string)

true or false, depending on whether a promotion is active or disabled.

Type

Optional (string)

REGULAR – product/cart line level discounts.
ORDER – quantity discounts.
GLOBAL – order-level discounts.
AFFILIATE – for discounts created by affiliates.

Promotions

Optional (Array of objects)

Details below.

Name

Optional (string)

Promotion name.

Description

Optional (string)

Promotion description.

StartDate

Optional (string)

The date when you set the promotion to start. NULL for promotions that start immediately after you create them.

EndDate

Optional (string)

The date when you set the promotion to end. NULL for promotions you want active indefinitely.

MaximumOrdersNumber

Optional (integer)

Avangate only applies the promotion to a maximum number of orders you define.

Can be NULL if you want the promotion to apply to an unlimited number of orders.

MaximumQuantity

Optional (integer)

Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.

InstantDiscount

Optional (boolean)

The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.

Coupon

Optional (string)

Promotion coupon/voucher.

DiscountLabel

Optional (string)

Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.

Enabled

Optional (string)

true or false, depending on whether a promotion is active or disabled.

Type

Optional (string)

REGULAR – product/cart line level discounts.
ORDER – quantity discounts.
GLOBAL – order-level discounts.
AFFILIATE – for discounts created by affiliates.

AdditionalFields

Optional (array of objects)

Details below.

Code

Optional (string)

The alpha-numeric characters, underscores and dashes that are set as the field identifier.

Text

Optional (string)

Field text visible to shoppers in the cart.

Value

Optional (string)

Selected field value.

Currency

Optional (string)

The currency ISO code for the payment - ISO 4217. Example: usd.

NetPrice

Optional (double)

Order value excluding sales tax/VAT expressed in the payment currency.

GrossPrice

Optional (double)

Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.

NetDiscountedPrice

Optional (double)

The NetPrice order value excluding sales tax/VAT, from which Avangate deducts discounts. NetDiscountedPrice is expressed in the payment currency.

GrossDiscountedPrice

Optional (double)

Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, Avangate and affiliate commissions, but Avangate deducts the value of any discounts.

For example:

Currency: "usd"
NetPrice: 396
GrossPrice: 486.29
NetDiscountedPrice: 376.2
GrossDiscountedPrice: 466.49
Discount: 19.8
VAT: 90.29
AffiliateCommission: 94.05

Discount

Optional (double)

Value of the discounts for an order expressed in the payment currency.

VAT

Optional (double)

Value of sales tax/VAT expressed in the payment currency.

AffiliateCommission

Optional (double)

Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. Avangate does not take into account shipping costs when calculating affiliate commissions.

FxMarkup

Optional (double)

Exchange rate markup for the order.

FxRate

Optional (double)

Exchange rate Avangate used for the order.

PayoutCurrency

Optional (string)

The ISO code of your account's payout currency - ISO 4217.

Customer

Overview

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

Retrieve a customer

Customer object

Parameters			Type/Description
AvangateCustomerReference			Int
			System-generated 2Checkout customer reference. null when you create a new customer. The 2Checkout system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions. Aggregate subscriptions under the same Customer account by adding the AV_CUSTOMERID (case sensitive) parameter to Buy links.
ExternalCustomerReference			String
			Unique customer alphanumeric (string) identifiers you control. Aggregate subscriptions under the same Customer account by adding the CUSTOMERID (case sensitive) parameter to Buy links.
FirstName			String
			Customer's first name.
LastName			String
			Customer's last name.
Company			String
			Company name.
FiscalCode			String
			Can be null for end users. For companies, it needs to be the VAT ID, which 2Checkout validates. 2Checkout throws an error if the VAT ID is invalid/incorrect. When present, you also need to provide the company name. Can be null for end users.
Address1			String
			Customer's address.
Address2			String
			Customer's address.
City			String
			Customer's city.
State			String
			Customer's state. For example, "Alabama","Alaska","Arizona".
Zip			String
			Zip code.
CountryCode			String
			Customer's country code (ISO 3166 two-letter code).
Phone			String
			Customer's phone number.
Fax			String
			Customer's fax number.
Email			String
			Customer's email.
ExistingCards			Array of objects
			Details below.
	TransientToken		Object
			Populated only with when you retrieve customer information by SSOToken.
		Token	String
			Token for the EXISTING_PAYMENT_DATA flow. Use it to charge customers using cards they used in the past for purchases from your 2Checkout account.
	CardType		String
			visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, elo, hipercard
	LastDigits		String
			Last four digits of the credit card.
	ExpirationMonth		String
			Card expiration month.
	ExpirationYear		String
			Card expiration year.
	NameOnCard		String
			Card holder name.
Enabled			Boolean
			true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription. Possible customer statuses: Active - Customer account status is Active even if Trial and Cancelled/Expired subscriptions exist for the customer, along as there's at least one Active subscription. Customers with a single subscription featuring the Past due status (expired but in the grace period) are considered Active. Inactive - All subscriptions associated to this Customer account are cancelled, expired or both. Trial - Customer account status is Trial if all Active subscriptions for this customer are trials, regardless of any Cancelled/Expired subscriptions.
Trial			Boolean
			true or false, depending on whether the customer account features only trials or also paid subscriptions.
Language			String
			ISO 639-1 two-letter code. Example: “en.”

Overview

Request parameters

Response

Request sample

Overview

Parameters

Mandatory parameters

Response

Sample request

Overview

Parameters

Response

Request

Parameters

Overview

Parameters

Response

Request

Overview

Requirements

Do local BR cards with/without installments require an addendum to my contract?

How does it work?

Funds collection for installment payments

Overview

Requirements

Overview

Attributes

Overview

Customer object

Need help?

Not yet a Verifone customer?