Documentation

Getting Started

Welcome to Currency Pal! Here's how to get started in just a few minutes:

1. Create an account - Sign up for free using email or social login (Google/Facebook)
2. Access your dashboard - After login, you'll see your personalized dashboard
3. Create your first widget - Click "Create Widget" to start building
4. Customize and embed - Choose your template, add currencies, and embed on your site

Creating Widgets

Widgets are the core of Currency Pal. Here's what you can configure:

• Widget Name - A descriptive name for your reference
• Base Currency - The currency your rates are relative to (e.g., USD, EUR)
• Display Currencies - Select which currencies to show (up to your plan limit)
• Template - Choose from 8 professional templates
• Theme - Select from 11 color themes or match your brand
• Markup/Markdown - Set your buy/sell rate adjustments
• Update Interval - How often rates refresh (plan-dependent)

Customization Options

Templates

We offer 8 professional templates:

• Clean Table - Simple, professional table layout
• Card Grid - Modern card-based grid
• Compact List - Space-efficient list view
• Modern Dashboard - Dashboard-style layout
• Elegant Grid - Premium grid layout
• Minimal Cards - Minimalist card design
• Executive Dashboard - Enterprise-grade display
• Luxury Display - High-end presentation

Themes

11 color themes to match any brand:

Light, Dark, Blue, Green, Purple, Red, Orange, Teal, Rose, Indigo, and Slate

Embedding Widgets

After creating your widget, you'll receive an embed code. Simply copy and paste it into your website:

The widget is fully responsive and will adapt to any container width.

WordPress Plugin

Our official WordPress plugin makes it easy to add currency exchange widgets to your WordPress website.

Installation

1. Download the plugin from our Downloads page
2. Go to Plugins → Add New in your WordPress admin
3. Click Upload Plugin and select the ZIP file
4. Click Install Now and then Activate

Using the Shortcode

Add a widget to any post, page, or widget area using the shortcode:

Shortcode Parameters:

• id (required) - Your widget UUID from the Currency Pal dashboard
• max_width (optional) - Maximum width of the widget (e.g., "500px", "100%")
• max_height (optional) - Maximum height of the widget (e.g., "400px")

Using the Gutenberg Block

The plugin also includes a Gutenberg block:

1. Edit any post or page with the block editor
2. Click the + button to add a new block
3. Search for "Currency Pal" and select the block
4. Enter your Widget ID and configure the display options

Joomla Module

Our native Joomla module allows you to display currency exchange widgets in any module position on your Joomla website.

Installation

1. Download the module from our Downloads page
2. Go to System → Install → Extensions in your Joomla admin
3. Upload the ZIP file and install
4. Go to Content → Site Modules
5. Find "Currency Pal" and click to configure

Configuration

In the module settings, configure the following:

• Widget ID - Your widget UUID from the Currency Pal dashboard
• Max Width - Maximum width of the widget (e.g., 500px or 100%)
• Max Height - Maximum height of the widget (e.g., 400px)
• Position - Select the module position in your template
• Menu Assignment - Choose which pages display the widget

Compatibility

The module is compatible with Joomla 2.5 and higher, including Joomla 3.x, 4.x, and 5.x.

Price Overrides

Enterprise users can create temporary rate adjustments:

• Schedule overrides - Set start and end dates/times
• Extra markup - Add additional percentage on top of base rates
• Weekend/holiday rates - Automatically apply different rates
• Multiple overrides - Stack different adjustments as needed

API Access

All plans include API access for programmatic rate retrieval:

• Free - 50 requests/month
• Pro - 10,000 requests/month
• Enterprise - 50,000 requests/month

For detailed API documentation, visit our API Reference.

Subscription Plans

Frequently Asked Questions