Documentation
Installation instructions
If downloaded package has .ocmod.zip extension, you can install it using Extension Installer. If you see "The directory is not allowed to be written to" error message, download Extension Installer Fix from this page and install it. Then install the main extension.
In any other case or if you want to install it manually, unpack and upload all folders to the root of your store. If there's install.xml file in the package, rename it to extension_name.ocmod.xml, replacing "extension_name" with extension's name, and upload it to "system" folder.
When upgrading from previous version rewrite all existing files. Refresh modifications cache from Extensions -> Modifications page.
Note for OpenCart 2.0.X users
Sometimes OCMod inserts modification in multiple files, which are separated by "|" character in XML-file. On earlier OpenCart 2 versions a comma was used instead. To quickly fix this, open XML file and replace all occurrences of "|" character with "," for "path" attribute in every applicable <file> element. Search for "<file path=" to quickly find and highlight all elements.
Note for OpenCart 2.3 users
On OpenCart 2.3 compatibility code is broken, which may lead to Permission Denied issue, when you access extension settings. To fix this you need to install OpenCart 2.3 Compatibility Fixes extension.
The right sequence of actions is the following:
- Download our purchased (or free) extension, but do not install it yet (uninstall, if already installed).
- Install OpenCart 2.3 Compatibility Fixes extension.
- Refresh modifications cache from Extensions -> Modifications page.
- Go to System -> User Groups and select all access/modify permissions for your group.
- Install our purchased (or free) extension.
If you did everything right, everything will start working properly.
Note for OpenCart 3 users
NOTE: Instructions below are required only if "admin" or "catalog" folders are present in the package!
To install and use extension on OpenCart 3 you need to install OpenCart 3 Compatibility Fixes. It adds backward compatibility with old extension structure plus adds back support for .tpl files and enables automatic template engine detection.
The right sequence of actions is the following:
- Download our purchased (or free) extension, but do not install it yet (uninstall, if already installed).
- Install OpenCart 3 Compatibility Fixes extension.
- Go to Extensions -> Modules section, install and enable Template Switcher.
- Refresh modifications cache from Extensions -> Modifications page.
- Go to System -> User Groups and select all access/modify permissions for your group.
- Install our purchased (or free) extension.
If you did everything right, everything will start working properly.
Permissions
In some cases it is required to manually set permissions for installed extension. To do this go to System -> User Groups, find your group and select access/modify permissions for desired extension. You can find extension in permissions list by folder/filename pair (for example, marketing/acoupon).
Extension Setup
Go to Extensions -> Payment, find PayPal Invoices, click Install and then setup accordingly.
How to Use
Go to PayPal Developer page and login with your PayPal account. On Applications page create a new application and then copy Client ID and Secret values to corresponding fields in extension settings. Save the settings and fill the info under Invoicer tab. Note that if you're using Sandbox API credentials, you must use Sandbox Account email instead of your main PayPal email.
Settings
Basic extension settings.
- License ID - Your order ID from opencart.com or our site.
- Action Link - Link to use in cron command or execute in the browser. Checks for invoice statuses and updates order statuses correspondingly.
- Action Secret - Any random sequence of characters for increased security of action link.
- Client ID - PayPal application Client ID. Make sure you use Sandbox credentials when Sandbox Mode is set to yes.
- Secret - PayPal application Secret. Make sure you use Sandbox credentials when Sandbox Mode is set to yes.
- Sandbox Mode - Turns PayPal Sandbox mode on/off.
- Sent Status - Order status, when invoice is sent (payment pending).
- Comment on Sent - Will be added to order history, when invoice is sent.
- Paid Status - Order status, when invoice is paid (order processing).
- Comment on Paid - Will be added to order history, when invoice is paid.
- Canceled Status - Order status, when invoice is canceled.
- Comment on Cancel - Will be added to order history, when invoice is canceled.
- Error Status - Order status, when invoice wasn't created due to some error.
- Comment on Error - Will be added to order history, when invoice wasn't created due to some error.
- Redirect Customer - Redirect customer to invoice link on checkout.
- Order Subtotal - Order subtotal minimum and maximum values, when this payment method is available (e.g: 10, 10-20 etc).
- Payment Methods - Available payment methods for invoices (empty - all available).
- Debug - API requests and responses will be saved in the log for additional debugging. Disable, when not needed!
- Check Version - Disable, if settings page loads too slow or connection errors displayed.
- Stores - Method will be available only for selected stores (empty - available for all stores).
- Customer Groups - Method will be available only for selected customer groups (empty - available to everyone, including guests).
- Geo Zone - Method will be available to selected geo zones only (empty - available for all geo zones).
- Status - Quickly enable/disable extension.
- Sort Order - Position in the list of available payment methods.
Invoicer
Information about invoicer which will be used in API requests and displayed on all invoices.
- Business Name - Your business (company) name.
- Recipient's Name - First and last name of the recipient.
- Address Country - Your business address country.
- Address Zone - Your business address zone (region).
- Address City - Your business address city.
- Address Line 1 - Your business address street, office etc., line 1.
- Address Line 2 - Your business address street, office etc., line 2
- Address Postcode - Your business address postcode.
- Email - Your PayPal email address (empty - take default store email).
- Phones - List of phones separated by comma.
- Website URL - Custom website URL (empty - take default store URL).
- Tax ID - Your tax ID if any.
- Additional Notes - Any custom note, which will be added to each invoice.
- Invoice Logo - Custom logo for the invoice (empty - take default store logo).
Miscellaneous
Besides extension settings you will find additional buttons on View Order page: View, Remind and Cancel. View button will open invoice for selected orders. Remind button will resend invoice to customers. Cancel button will cancel invoices for selected orders.
Most invoice and order updates are processed automatically, when you run the action link manually or with the help of cron service. Extension sends requests to PayPal and then updates orders, if invoice status has changed (e.g. from Sent to Paid).
