Payment Plugins

[TOC]

Overview

OS Calendar comes with a built-in plugin-based payment system. Payment plugins allow customers to pay for their booking using a variety of online payment methods. Each payment method is implemented as an independent plugin that can be installed, published, configured, and removed independently.

To manage payment plugins, go to Components → OS Calendar → Manage Payment Plugins.

Included Payment Plugins

OS Calendar ships with the following payment plugins out of the box:

Plugin Description
PayPal Standard PayPal checkout (supports both test and live mode).
Stripe Stripe card payment (requires Stripe API keys).
Offline / Bank Transfer Customers submit the booking without online payment; payment is collected offline.

Plugin List

The plugin list shows:

Column Description
Plugin Name Internal identifier of the plugin
Title Display name shown on the booking form
Author Plugin developer
Version Plugin version
Ordering Display order on the payment method selection list
Published Published / Unpublished; only published plugins appear on the front-end.

Installing a New Plugin

  1. Click Browse in the upload section at the top of the plugin list.
  2. Select the .zip package of the payment plugin.
  3. Click Upload & Install.

The plugin will appear in the list. Publish it to make it available on the front-end.

Configuring a Plugin

  1. Click on the plugin name (or select it and click Edit in the toolbar).
  2. The edit form shows:
    • Plugin Name, Title, Author, Version — read-only metadata.
    • Published — toggle published status.
    • Plugin Parameters — configuration fields specific to this plugin (e.g. PayPal email, API keys, currency).
  3. Click Save or Apply.

Publish / Unpublish

Use the Publish and Unpublish toolbar buttons, or click the status icon in the Published column, to enable or disable individual payment methods without deleting them.

Ordering

The order of published plugins determines the order they appear in the payment method list on the booking confirmation form. Drag the handles to reorder, or use the ordering column values directly. Click Save Order when done.