Sign Up Sign in Blog Support

CashSender Joomla! Plugin Documentation

Installation
Adding the buttons in your page
Overriding plugin paramters
Tag paramters reference
Advanced plugin paramters

Overview

The CashSender Joomla! Extension allows you to add Buy Now and Shopping Cart buttons easily in your Joomla site.

Installation

  1. Download the plugin here
  2. If you don't already have one, sign up for a CashSender account
  3. Install the pluging using Extension Manager in the Joomla! admin
  4. Go to Extensions -> Plugin Manager and click the link to the plugin "CashSender Buttons"
  5. Select "Yes" under "Enabled"
  6. Configure the button parameters on the right
  7. CashSender Sandbox: Select "On" if you are using the sandbox for testing. "Off" for live CashSender site.
  8. CashSender Account Email: Enter the email associated with your CashSender account.
  9. CashSender Sandbox Email: Enter the email associated with your CashSender Sandbox accout (required if you are using test mode)
  10. Default Button Size: Select the size of the button (applies only if you are not using your own button image)
  11. Button Image URL: If you want to use your own image for the button, enter the URL here. Leave blank if you want to use the preset CashSender image.
  12. Currency: Enter the code for the currency.
  13. Weight Unit: Select the weight unit. Only useful if you are using the shipping calculator with weight method
  14. Shipping Cost: Enter the default shipping cost of each item
  15. Tax Rate: Enter the default tax rate in percentage
  16. Succcess Return URL: If you want to redirect your user back to your store after the payment, enter the URL where you want to redirect your user to.
  17. Cancel Return URL: If you want to redirect your user back to your store if he clicks "Cancel" during the payment process, enter the URL where you want to redirect your user to.
  18. Save the plugin configuration

Adding the buttons in your page

Add the following tag code to your article

Buy Now button - {cashsender button_type="buynow" name="Item Name " price="1.20" /}

Add to Cart button - {cashsender button_type="add_to_cart" name="Item Name " price="1.20" /}

View Cart button - {cashsender button_type="view_cart" /}

Optional: If you use the shipping calculator using weight, add the "weight" paramter.
Example: {cashsender button_type="buynow" name="Item Name " weight="5" price="1.20" /}

Optional: You can also add an item ID by adding the item_id parameter.
Example: {cashsender button_type="buynow" name="Item Name " item_id="ID12345" price="1.20" /}

Overriding plugin paramters

If you want to create a button that has different setting than the parameters in the plugin settings (for example, currency), you can add parameters in the tag to override them. (see below of a full list of paramters)

Example

Override the currency to British Pound (GBP):
{cashsender button_type="buynow" name="Item Name " price="1.20" currency="GBP" /}

Set shipping cost of the item to $1 and tax rate to 5%:
{cashsender button_type="buynow" name="Item Name " price="1.20" shipping_flat="1" tax_percent="5" /}

Tag paramters reference

Below is a list of paramters that can be added in the tag:

Variable name Description Specification
button_type Type of button to be generated Buy Now button: "buynow" (default)
Add to Cart button: "add_to_cart"
View Cart button: "view_cart"
name Name of the item Required.
price Price of the item Required.
item_id Item ID Optional.
weight Weight of the item Optional.
(For using shipping calculator and weight method)
new_window Open in new window? 1 = Yes
0 = No Optional, override plugin settings.
weight_unit Unit of the weight of the item 1 = kg
2 = pound

Optional, override plugin settings.
sandbox Use CashSender Sandbox (Test Mode)? 1 = Yes
0 = No

Optional, override plugin settings.
email Email associated with your CashSender account Optional, override plugin settings.
sandbox_email Email associated with your CashSender Sandbox account Optional, override plugin settings.
button_size Button size (if using preset CashSender buttons) Optional, override plugin settings.
button_url Custom button image URL Optional, override plugin settings.
currency Currency (3 letter code) Optional, override plugin settings.
shipping_flat Shipping cost of the item Optional, override plugin settings.
tax_percent Tax rate in percentage Optional, override plugin settings.
success_url Return URL after successful payment (leave blank if you don't want to redirect your user back to your site) Optional, override plugin settings.
cancel_url Return URL if user click "cancel" during the payment process (leave blank if you don't want to redirect your user back to your site) Optional, override plugin settings.

Advanced tag paramters

There are additional parameters you can add to the button tag. These parameters has the same name and specification as the HTML variable name for the buy now button and shopping cart buttons. The only exception are the parameters "stage" and "email".

Example

Use shipping and tax calculator:
{cashsender button_type="buynow" name="Item Name " price="1.20" shipping="3" tax="3" /}

Enable quantity option and set shipping cost for first unit and every unit after the fist:
{cashsender button_type="buynow" name="Item Name " price="1.20" quantity="1" first_shipping="0.5" after_first_shipping="0.2quot; /}