Summary

The PRO version of the plugin provides a great deal of configuration to ensure that the plugin meets the needs of your J2Store.

This chapter describes each of the configuration tabs in the administrator control panel, their purpose and their expected data types with examples., where applicable.

NOTE: Take some time to familiarise yourself with the plugin settings. Misconfiguration of the plugin can cause unexpected behaviour.

Plugin

The plugin tab describes the general payment plugin parameters.

• Payment Option Title - The title displayed for this plugin as a payment method
• Plugin Display Image - The icon displayed for this plugin as a payment method

Wallet

The Wallet tab contains the parameters required for accessing your digital wallet.

• Wallet API URL - the URL of the digital wallet API
• Wallet API Key - the key to verify access for requests to the digital wallet API
• Wallet API xPub - your Extended Public Key (xPub) connected to your digital wallet
• Secret Key - a locally defined secret key to verify callback responses from the payment API.

Exchange Rate

The Exchange Rate tab is used to configure the API for calculating the exchange rate for Bitcoin (BTC)

• Exhange Rate API URL - the url of the exchange rate API. Defaults to the Exchange Rate API of the provider associated with the plugin

Discounts

Discounts can be either a fixed value or a percentage of either the order items base price or online sale price.

Discounts can be applied to none, one or more of products, categories and/or users. Leave the discount amount field empty or set to zero (0) to NOT apply any discount.

• Qualifying Products - a comma separated list of product_id's that qualify for the discount. Leave blank to apply to ALL products
• Qualifying Categories - a multi-select option of categories that qualify for the discount. Clear entries to apply to ALL categories
• Include Sub-Categories - automatically include all sub categories when selecting a parent category above
• Qualifying Users - a multi-select option of user access groups that qualify for the discount. Clear entries to apply to ALL user access groups
• Discount Amount - the value in local currency of the discount to be applied. Leave blank to apply NO discount
• Discount Type - the discount amount is a percentage (or the order item cost) or a fixed fee
• Discounted Price - should the discount be applied to the base price (higher) or sale price (lower)

Transaction Fees

Transaction fees can be either a fixed value or a percentage of the total order value. Leave the transaction fee field empty or set to zero (0) to NOT apply any transaction fees.

• Transaction Fee (BTC) - the value in BTC of the transaction fee to be applied
• Transaction Fee Type - the transaction fee value is a percentage (or the order total) or a fixed fee

Labels

Labels allow customisation at key events during the order process.

The labels configured here will override the default values.

• onSelection Text - the text displayed to the user when this payment method is selected
• onBeforePayment Text - the text displayed to the user at the BEFORE Payment stage of checkout
• onAfterPayment Text - the text displayed to the user at the AFTER Payment stage of checkout
• onErrorPayment Text - the text displayed to the user when a payment has an ERROR
• onCancelPayment Text - the text displayed to the user when a payment is cancelled

Order Processing

Bitcoin order processing is mapped to J2Store order status to ensure consistency through your online store.

The PRO version allows cusom order status mapping to take into account any specific customisation you have already applied to your store.

• Order CREATED - the J2Store order status to map to the Bitcoin Order CREATED event
• Order CANCELLED - the J2Store order status to map to the Bitcoin Order CANCELLED event
• Order FAILED - the J2Store order status to map to the Bitcoin Order FAILED event
• Order RECEIVED - the J2Store order status to map to the Bitcoin Order RECEIVED event
• Order COMPLETE - the J2Store order status to map to the Bitcoin Order COMPLETE event

Debug

Having problems with accepting bitcoin payments? Take advantage of the built-in debug feature.

With debug selected, processing messages are output to a log file to assist with problem solving.

• Debug - Debug the payment plugin and log the results. 

The log file will be created in your system log folder, and is named: package_name.log.php, where package_name is the name of your payment plugin package, e.g. plg_bitcoin_payment.log.php.

To check which folder is configured as your system log folder, logon to your Joomla! Administrator account, and:

• Select from the top menu: System -> Global Configuration -> System