| Verifone Developer Portal

Availability

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

Akeeba Subscriptions Settings:

Login to your Joomla admin.
Under Extensions click Plugin Manager.
Select “Akeeba Subscriptions Payment – 2Checkout Standard Purchase Routine”
Under Status select Enabled.
Enter your Payment Option Title.
Enter your 2Checkout Merchant code.
Enter in your Secret Word (set on 2Checkout Control Panel.) To obtain the Secret Word, contact 2Checkout or, if you already have a 2Checkout account, log in to your Merchant Control Panel and navigate to Dashboard → Integrations → Webhooks & API → Secret Word → INS Secret word. Your INS secret word should be the same as the buy-link secret word (can be found under Dashboard → Integrations → Webhooks & API, scroll down to the Secret Word area, under the INS Secret Word). Edit your INS secret word and buy-link secret word to match each other, then copy and paste them into your Akeeba admin.
Under Demo mode select No.
Select whether or not you will be placing demo sales. (INS messages are not sent on demo sales so all demo sales will have a payment status of New and will not be enabled.)
Select the default payment method for your buyers on the checkout page.
Under Checkout Process select Single Page.
Save your changes.

2Checkout Settings:

Sign in to your 2Checkout account.
Navigate to Dashboard → Integrations → Webhooks & API
Follow these steps to activate Redirect URL:
- In the Redirect URL section check “Enable return after sale”
- For Return method, select Link in the Thank You Page or Header redirect
- Set the Approved URL to the URL provided in your Joomla admin (Replace http://yourdomain.com with the actual URL to your domain)
- Click Update to save your settings
In the Webhooks and API section, under the Instant Notification Service (INS) card, check the Enable Global URL box.
Enter “http://www.yourdomain.com/index.php?...thod=2checkout” as the Global URL (replace http://www.yourdomain.com with your actual website URL)
Enable all triggers.
Click Update to save your changes.

Akeeba Subscriptions

Akeeba Subscriptions is a component for the popular Joomla!™ CMS which allows you to sell subscriptions on your site, the easy way. Integrate directly with Joomla!’s built-in ACL and dozens of popular extensions. It comes with built-in support for 2Checkout’s payment processing service. Limit the displayed content based on your users’ subscription level. Be in control of your business policy with its powerful features. Integrate with the popular ccInvoices component for automatic invoicing. Use it with single- or multi-lingual sites. Comply with EU VAT laws with its powerful Tax Rules feature. And as with the best things in life, Akeeba Subscriptions is available free of charge from https://www.AkeebaBackup.com.

For more information visit: AkeebaBackup.com

Upgrade price

Overview

Retrieve the upgrade price for a subscription.

Attributes

Parameters	Type/Description
BillingPrice	Double
	The price Avangate charges the customer, without taxes.
BillingGrossPrice	Double
	The price Avangate charges the customer, including taxes.
BillingCurrency	String
	The currency ISO code used for the payment - ISO 4217.
Quantity	Int
	The mandatory quantity for the upgrade (you cannot make partial upgrades)
DisplayPrice	Double
	Display price.
DisplayGrossPrice	Double
	Display price before deductions.
DisplayCurrency	String
	Display currency. ISO 4217 code.
Discount	Float
	Applied discounts
DiscountedProratedPrice	Float
	Prorated net price for the upgrade with applied discounts
DiscountedProratedGrossPrice	Float
	Prorated gross price for the upgrade with applied discounts
DiscountedBillingPrice	Float
	Net billing price available for the upgrade process with applied discounts
DiscountedBillingGrossPrice	Float
	Gross billing price available for the upgrade process with applied discounts
DisplayDiscount	Float
	Discount displayed for the upgrade process
DiscountedDisplayPrice	Float
	Net display price available for the upgrade process with applied discounts
DiscountedDisplayGrossPrice	Float
	ross display price available for the upgrade process with applied discounts

Order

Coupons

Overview

Use this section to handle coupons that are part of your promotions.

You can add, update or remove coupons that are configured on your promotional campaigns.

API 3.0

This category is about the JSON API version 3.0 and the methods it uses.

API 4.0

This category contains the methods used by the JSON-RPC API version 4.0.

Affiliates

Overview

The Affiliates object helps you to search and extract information about your affiliates using JSON-RPC API 6.0.

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.

Cross-sell

Overview

Cross-selling allows you to recommend additional products to customers and increase the average order value. The 2Checkout Public API supports classic cross-sell campaigns which means you can recommend more products from your own product catalog to your shoppers.

CrossSell Object

Use the CrossSell object to recommend additional products to customers via the 2Checkout API.

Parameters

Parameter		Type/Description
MasterProducts		Array
		Array of product codes for the items you set to trigger the cross-sell campaign.
DisplayType		String
		cart – Shopping cart review – Review page finish – Thank you page
DisplayInEmail		Boolean
		True or false depending on whether you set the cross-sell campaign to display in payment receipt emails or not.
Products		Array of objects
		Details below
	ProductCode	String
		Product code for the item you set as recommended for the cross-sell campaign.
	Discount	String
		Value of the discount. This is a percentage.
	DiscountType	String
		PERCENT – you can only set discounts as a percentage from the product price.
	Type	String
		Example: Own
	AutoAdded	Boolean
	DiscountedPrice	Array of objects
		Details below.
	Currency	String
	Price	Float
	BasePrice	Array of objects
	Currency	String
	Price	Float
CampaignCode		String
		Unique, system-generated cross-sell campaign code.
Name		String
		Campaign name.
StartDate		String
		YYYY-MM-DD. The start date you set for the cross-sell campaign.
EndDate		String
		YYYY-MM-DD. The end date you set for the cross-sell campaign.
CampaignStatus		String
		The status of the cross-sell campaign.
CampaignOwnerType		String
		Campaign owner type: Can be either MERCH or AFF.

Subscription

Overview

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

Subscription object

Parameters				Type/Description
SubscriptionReference				String
				Unique, system-generated subscription identifier.
StartDate				String
				Subscription start date(ISO 8601) - StartDate is mandatory when importing subscription data. If you changed the time zone for the Avangate API by editing system settings under Account settings, then the StartDate you provide must be in accordance with your custom configuration.
ExpirationDate				String
				Subscription expiration date(ISO 8601) - ExpirationDate is mandatory when importing subscription data. If you changed the time zone for the Avangate API by editing system settings under Account settings, then the ExpirationDate you provide must be in accordance with your custom configuration.
RecurringEnabled				Boolean
				Possible values: TRUE – recurring billing/automatic subscription renewals enabled FALSE– recurring billing/automatic subscription renewals disabled
NextBillingDate				Date
				The date when the client will be billed next (ISO 8601).
SubscriptionEnabled				Boolean Possible values: TRUE –subscription enabled FALSE–subscription disabled
Product				Required (object)
				The product for which Avangate generated the subscription. Details below.
	ProductCode			String
				Unique product identifier that you control.
	ProductId			Int
				Unique, system-generated product identifier.
	ProductName			String
				Product name.
	ProductQuantity			Int
				Ordered number of units.
	ProductVersion			String
				Product version.
	PriceOptionCodes			Array
				The product options codes the customer selected when acquiring the subscription. Pricing options codes are case sensitive.
EndUser				Object
				The end user of the subscription. Details below.
	Person			Object
		FirstName		String
				End user's first name
		LastName		String
				End user's last name
		CountryCode		String
				End user country code [ISO3166-1 Alpha 2].
		State		String
				End user state.
		City		String
				End user city.
		Address1		String
				End user first address line.
		Address2		String
				End user second address line.
		Zip		String
				End user zip code.
		Email		String
				End user email address.
		Phone		String
				End user phone number.
		Company		String
				Company name.
		Fax		String
				End user fax.
		Language		String
				Language [ISO639-2] the Avangate system uses for communications.
SKU				String
				Stock keeping unit you defined.
DeliveryInfo				Object
				The object contains information about the delivery/fulfillment made to the customer.
	Description			String
				Delivery description.
	Codes			Array of objects
		Code		String
				Activation key/license code of the first order from this subscription. Use getSubscriptionHistory method if you want to retrieve the activation keys/license codes for all orders belonging to a subscription.
		Description		String
				Code description for dynamic lists from your key generator.
		ExtraInfo		Object
				Info set by your key generator for dynamic lists only.
			CodeExtraInfo	Object
			Type	String
			Label	String
			Value	String
		File		Array of objects
			Content	String
				Content of the file (base64 encoded).
			ContentLength	Int
				File size.
			Filename	String
				The name of the delivered file.
			FileType	String
				The type of the delivered file.
ReceiveNotifications				Boolean
				1 – Subscribe: Avangate sends subscription notifications to the end user. 0 – Unsubscribe – Avangate does not send subscription notifications to the end user.
Lifetime				Boolean
				Possible values: True – the subscription is evergreen False – the subscription has a recurring billing cycle less than or equal to three years.
PartnerCode				String
				Empty: for ecommerce orders Partner Code
AvangateCustomerReference				Int
				Unique, system-generated customer identifier.
ExternalCustomerReference				String
				Customer identifier that you control.
TestSubscription				Boolean
				True for test subscriptions, false otherwise.
IsTrial				Boolean
				True for trial subscriptions, false otherwise.
MerchantCode				String
				Unique, system-generated ID in the Avangate system.

Global eCommerce

In-Person Payments

Business Tools

Petroleum & Convenience

APIs

Reference

Integrate Akeeba Subscriptions

Availability

Akeeba Subscriptions Settings:

2Checkout Settings:

Akeeba Subscriptions

Upgrade price

Overview

Attributes

Order

Coupons

Overview

API 3.0

API 4.0

Affiliates

Overview

Cross-sell

Overview

CrossSell Object

Parameters

Subscription

Overview

Retrieve a subscription

Search subscriptions

Retrieve customer's subscriptions

Retrieve specific subscriptions

Subscription object

Need help?

Not yet a Verifone customer?