Blesta SHKeeper Payment Module

A SHKeeper payment gateway module for Blesta billing software, enabling seamless crypto payment processing for your billing operations.

Requirements

• Blesta 5.0 or higher
• PHP 8.2 or higher
• Valid SHKeeper payment gateway account
• cURL PHP extension enabled
• OpenSSL PHP extension enabled

Package Contents

This package includes two components that must be installed:

1. Payment Gateway Module - Handles payment processing, SHKeeper transactions, callbacks, and order tracking
2. SHKeeper Plugin - Generates dynamic SHKeeper payment addresses and QR codes via AJAX.

Installation

Part 1: Installing the Plugin

The plugin must be installed first as it provides core functionality for the payment module.

1. Download the latest release from the Releases page
2. Extract the downloaded archive
3. Locate the plugin folder (e.g., shkeeper/)
4. Upload the plugin folder to your Blesta plugins directory:

   /path/to/blesta/plugins/shkeeper/
   

5. Set appropriate permissions:

   chmod -R 755 /path/to/blesta/plugins/shkeeper/

Activating the Plugin

1. Log in to your Blesta admin panel
2. Navigate to Settings > Company > Plugins
3. Click on the Available tab
4. Find "SHKeeper" in the list
5. Click Install
6. The plugin is now active and ready

Part 2: Installing the Payment Gateway Module

After the plugin is installed, proceed with the gateway module installation.

1. Locate the gateway module folder from the extracted archive
2. Upload the module folder to your Blesta gateways directory:

   /path/to/blesta/components/gateways/nonmerchant/shkeeper/
   

3. Set appropriate permissions:

   chmod -R 755 /path/to/blesta/components/gateways/nonmerchant/shkeeper/

Enabling the Gateway

1. In Blesta admin panel, navigate to Settings > Payment Gateways
2. Click the Available tab
3. Find your SHKeeper gateway in the list and click Install
4. Configure the gateway settings (see Configuration section below)

Configuration

Gateway Settings

Configure the following settings for your SHKeeper payment gateway:

Setting	Description	Required
API Key	Your payment gateway API key	Yes
API Base URL	Your gateway API base URL	Yes

Assign to an Order Form

1. Go to Packages > Order Forms.
2. Edit the relevant order form or create a new one.
3. Scroll to the bottom of the page and select SHKeeper under the payment gateways section.

Usage

For Clients

Once configured, clients can pay with SHKeeper:

1. Navigate to the invoice payment page
2. Select the SHKeeper payment gateway
3. Choose the desired cryptocurrency (Bitcoin, Ethereum, etc.)
4. Send payment to the provided address or scan the QR code
5. Payment will be confirmed automatically via blockchain

For Administrators

• Settings > Payment Gateways > Manage - Configure gateway settings
• Billing > Transactions - View all payment transactions

Supported Features

• ✅ Multiple cryptocurrency support via SHKeeper
• ✅ Real-time exchange rates
• ✅ QR code generation for easy payments
• ✅ Automatic payment confirmation via blockchain
• ✅ Transaction tracking and status updates
• ✅ Underpayment/overpayment handling
• ✅ Transaction logging and history

Troubleshooting

Plugin Not Appearing

• Verify the plugin files are in /plugins/shkeeper/ directory
• Check file permissions (755 for directories, 644 for files)
• Clear Blesta cache: Tools > System > Cache > Empty Cache
• Check error logs at /path/to/blesta/logs/

Gateway Not Appearing

• Ensure the plugin is installed and activated first
• Verify the module files are in the correct directory
• Check file permissions
• Clear Blesta cache

Common Errors

"Invalid API credentials"

• Double-check your API key in gateway settings
• Verify the API Base URL is correct

"Connection failed"

• If using a custom API Base URL, ensure it's accessible and correct
• Check if your server can make outbound HTTPS connections

"Underpayment detected"

• Payment amount was less than required (due to transaction fees or exchange rate changes)
• Check plugin settings for underpayment tolerance

Security Considerations

• Always use HTTPS for your Blesta installation
• Keep API keys secure and never share them publicly
• Regularly update the plugin and gateway module
• Monitor transaction logs for suspicious activity
• Use IP whitelisting if your gateway provider supports it