Joomla Membership Pro Payment Plugins Documentation

Once you have purchased a Joomla Membership Pro payment plugin from our website, simply login into your account and navigate to My Downloads page to download the plugin.

The next step is to login into your Joomla website and navigate to Components => Membership Pro => Payment Plugins page.

Remember, you must have the Membership Pro component extension already installed and activated on your website before now.

Please note that you cannot use the default Joomla extension install interface to install Membership Pro payment plugin.

On the Payment Plugins page, simply locate the Install New Plugin section on the bottom-left corner of the page and click on the Browse button.

Locate the payment plugin zip file that you have downloaded and click on Install button to install the plugin.

After installation is complete, simply click on the name of the new plugin you just installed to configure and enable it for your Membership Pro extension.

Find below configuration guides for different Membership Pro payment plugins we have.

At this stage, we assume you have downloaded and installed the Membership Pro Paystack payment plugin and now on the Components => Membership Pro => Payment Plugins page.

Click on the os_paystack payment plugin link to open the configuration page for Paystack payment plugin.

Below are detailed explanations for the various configuration fields on the page.

• (1) Title

  Enter the name that you would like to show in the frontend for the Paystack payment method.

• (2) Published

  Select Yes if you would like to show this payment method in the frontend subscription form under payment methods; otherwise, select No.

• (3) Icon

  If you want to show a logo instead of the payment method's title on the frontend subscription form, then upload the logo to YOUR_SITE_ROOT/media/com_osmembership/assets/images/paymentmethods/ folder and enter the name of the file here. For example, os_paystack.png.

  We have designed and uploaded some sample logos which you can login and download from the download page.

• (4) Paystack Mode

  Select Test Mode if you are just testing your website; otherwise, select Live Mode if your website is live and ready to accept real payments. The default setting is Test Mode.

  
  

  WARNING: Never select the Test Mode on a live website that is meant to accept real payments.

• (5) Paystack Payment Method

  Select Modal Popup (Inline) if you want to use the Paystack on-the-site modal popup payment method, or select Redirect (Standard) if you want to use the Paystack off-the-site redirect payment method. The default setting is Redirect (Standard).

  
  

  NOTE: Redirect (Standard) method requires your website to have a valid SSL certificate installed and can conclude a TLSv1.2 connection to Paystack server. Most up-to-date server have this capability. Contact your service provider for guidance if you have any SSL errors.

• (6) Live Secret Key

  Login into your Paystack account (https://dashboard.paystack.com/#/login) if you already have an account with them, or simply register a new merchant account (https://dashboard.paystack.com/#/signup) if you don't already have an account with them.

  If you have more than one Business Account in your Paystack account, then make sure you have switched to the right business account for your website before going to the next step.

  Secondly, make sure you have verified your Paystack account before moving to the next step.

  Inside your Paystack account, click on the user icon, then Settings on the top-right corner of the page or on the Settings menu link on the bottom-left corner of the page to navigate to the Settings page.

  
  

  
  Then click on the API Keys & Webhooks tab to locate your Paystack API Keys.

  
  

  
  Now copy and paste your Paystack Live Secret Key into the Live Secret Key field in your plugin settings.

• (7) Live Public Key

  Also copy and paste your Paystack Live Public Key into the Live Public Key field in your plugin settings.

• (8) Test Secret Key

  Still on the Paystack Settings => API Keys & Webhooks page, scroll down to locate your Paystack Test API Keys.

  
  

  
  Also copy and paste your Paystack Test Secret Key into the Test Secret Key field in your plugin settings.

• (9) Test Public Key

  Also copy and paste your Paystack Test Public Key into the Test Public Key field in your plugin settings.

  
  

  By default, international payment is not enabled by Paystack. That means you can only process payment from Nigerian bank issued cards and other local payment options.

  To be able to process international cards payment, you need to request for international payments activation from your Paystack Settings page, under the Preferences tab.

  Once international payments has been activated for your Paystack account, you can now process international cards payment both in Naira (NGN) and Dollar (USD) if you have provided Paystack with the required GTBank USD domiciliary bank account for USD settlement.

• (10) Payment Processing Fee (Fixed - $)

  Enter payment gateway fixed processing fee. Leave empty if you do not want to include any fixed amount.

• (11) Payment Processing Fee (Percentage - %)

  Enter payment gateway percentage processing fee. Leave empty if you do not want to include any percentage amount.

After every field has been set up, click on Save & Close button at the top to save the payment plugin configuration.

Now Paystack payment method will start showing on the frontend subscription form, ready for visitors to choose it as their preferred payment method.

At this stage, we assume you have downloaded and installed the Membership Pro Coinbase Commerce payment gateway plugin and now on the Components => Membership Pro => Payment Plugins page.

Click on the os_coinbase payment plugin link to open the configuration page for the Coinbase Commerce payment plugin.

Below are detailed explanations for the various configuration fields on the page.

• (1) Title

  Enter the name that you would like to show in the frontend for the Coinbase Commerce payment method.

• (2) Published

  Select Yes if you would like to show this payment method in the frontend subscription form under payment methods; otherwise, select No.

• (3) Icon

  If you want to show a logo instead of the payment method's title on the frontend subscription form, then upload the logo to YOUR_SITE_ROOT/media/com_osmembership/assets/images/paymentmethods/ folder and enter the name of the file here. For example, os_coinbase.png.

  We have designed and uploaded some sample logos which you can login and download from the download page.

• (4) Coinbase Payment Method

  There are two options for you to select:

  1) Redirect

  Select the Redirect option for off-the-site redirect payment method. Subscriber will be redirected to a unique Coinbase Commerce payment page to complete their payment.

  
  
  

  2) Modal

  Select Modal option for on-the-site modal pop up payment method. Subscriber will be presented with a modal pop up and will be able to complete payment without leaving your website.

  
  

  
  

  INSTRUCTION: If you selected the Modal option above, then you need to perform the following task:

  
  

  1. Download the Payment Gateways Logo zip file from the download page on this website.

     

     
     

  2. Unzip the downloaded file and locate the coinbase folder within. Copy the folder to YOUR_SITE_ROOT/media/com_osmembership/assets/images/paymentmethods/ folder. You can do this via your cPanel or using an FTP client. This folder contains the necessary image files needed to display the Coinbase Commerce and crytocurrencies logos on the modal pop up.

     

• (5) Coinbase Commerce API Key

  Login into your Coinbase Commerce account (https://commerce.coinbase.com/) and navigate to the Settings page.

  
  

  
  Scroll down and locate the API Keys section. Click on Create an API Key link to create a new API key that will be used to connect your website to your Coinbase Commerce account.

  Copy the created API Key from Coinbase Commerce settings page and paste it into the Coinbase Commerce API Key field in your plugin settings.

• (6) Your Coinbase Commerce Webhook URL

  You need to create a Webhook Subscription within your Coinbase Commerce account by following the steps below:

  1. Navigate to the Settings page in your Coinbase Commerce account and scroll down to the Webhook Subscriptions section. Click on the Add an endpoint link to open a subscription box.

     
     

     
     

  2. Copy the full URL in your plugin settings Your Coinbase Commerce Webhook URL field into the Coinbase Commerce New Webhook Subscription endpoint field.

     
     

     
     

  3. Finally, click on the Save button to save the webhook subscription.

• (7) Coinbase Webhook Shared Secret

  Still on the Webhook Subscriptions section, click on the Show shared secret link to reveal your Coinbase Commerce Webhook Shared Secret.

  Copy and paste the shared secret into the Coinbase Webhook Shared Secret field within your plugin settings.

  
  

• (8) Coinbase Success URL

  Enter full URL (e.g., https://example.com/redirect-url) to return customers to after they have paid and waiting for routine confirmations to finish taking place before their subscription is automatically activated by the plugin.

  You can put full URL to an article published on your website where you inform customers to wait some time for their payment to finish required confirmations before their subscription can be automatically activated. See an example here.

  If this field is empty, subscribers will be returned to the normal subscription complete thank you page.

• (9) Payment Processing Fee (Fixed - $)

  Enter payment gateway fixed processing fee. Leave empty if you do not want to include any fixed amount.

• (10) Payment Processing Fee (Percentage - %)

  Enter payment gateway percentage processing fee. Leave empty if you do not want to include any percentage amount.

• Plugin Language Translation for Multilingual Website

  If you run a multilingual website and you have selected the Modal payment method option under Coinbase Payment Method settings above, then you might need to translate the plugin payment instructions to other languages apart from English (en-GB).

  The highlighted areas in the screenshot image below can be translated easily.

  
  

  
  To translate, simply follow the steps below:

  1. Navigate to the following folder, YOUR_SITE_ROOT/components/com_osmembership/plugins/coinbase/language/, in your site root.
  2. Then clone (make a copy of) the en-GB language folder.
  3. Rename the cloned folder to your desired language code, for example, fr-FR for French language.
  4. Open the renamed folder and rename the language file's language code prefix accordingly. For example, rename the language file from en-GB.coinbase.ini to fr-FR.coinbase.ini.
  5. Lastly, open the renamed language file and translate the existing language constants accordingly.
  6. You should repeat these steps for all the active languages on your website.

After every field has been set up, click on Save & Close button at the top to save the payment plugin configuration.

Now Coinbase Commerce payment method will start showing on the frontend subscription form, ready for subscribers to choose it as their preferred payment method.

At this stage, we assume you have downloaded and installed the Membership Pro Coinpayments payment plugin and now on the Components => Membership Pro => Payment Plugins page.

Click on the os_coinpayments payment plugin link to open the configuration page for the Coinpayments payment plugin.

Below are detailed explanations for the various configuration fields on the page.

• (1) Title

  Enter the name that you would like to show in the frontend for the Coinpayments payment method.

• (2) Published

  Select Yes if you would like to show this payment method in the frontend subscription form under payment methods; otherwise, select No.

• (3) Icon

  If you want to show a logo instead of the payment method's title on the frontend subscription form, then upload the logo to YOUR_SITE_ROOT/media/com_osmembership/assets/images/paymentmethods/ folder and enter the name of the file here. For example, os_coinpayments.png.

  We have designed and uploaded some sample logos which you can login and download from the download page.

• (4) Coinpayments Merchant ID

  Login into your Coinpayments account (https://www.coinpayments.net/) and navigate to Account => Account Settings page.

  
  

  
  Under Basic Settings tab, copy Your Merchant ID from Coinpayments website and paste it into the Coinpayments Merchant ID field in your plugin settings.

  
  

• (5) Coinpayments IPN Secret

  On the same Coinpayments Account Settings page, under Merchant Settings tab, generate and paste your IPN Secret string. Your IPN Secret should be a strong random string nobody can guess.

  Then paste the same IPN Secret string you generated into the Coinpayments IPN Secret field in your plugin settings.

  
  

  
  After, click on the Update Account button at the bottom of the page to save the settings on Coinpayments website.

• (6) Coinpayments Allowed Currencies

  It is a good idea to choose the set of coins/crytocurrencies that you wish to accept for payment. To do just that, simply go to Account => Coin Acceptance Settings in your Coinpayments website dashboard and choose your acceptable coins/cryptocurrencies.

  Now, the currency codes entered in this plugin field will be used to further restrict acceptable coins.

  Simply enter supported currency codes separated with comma of coins you wish to accept. This is used to further restrict the coin selection from your list of enabled coins in the Coinpayments website Coin Acceptance Setting.

  Leave empty if you do not want to further restrict acceptable coins.

• (7) Coinpayments Success URL

  Enter full URL (e.g., https://example.com/redirect-url) to return customers to after they have paid and waiting for routine confirmations to finish taking place before their subscription is automatically activated by the plugin.

  You can put full URL to an article published on your website where you inform customers to wait some time for their payment to finish required confirmations before their subscription can be automatically activated. See an example here.

  If this field is empty, customers will be returned to the normal subscription complete thank you page.

• (8) Payment Processing Fee (Fixed - $)

  Enter payment gateway fixed processing fee. Leave empty if you do not want to include any fixed amount.

• (9) Payment Processing Fee (Percentage - %)

  Enter payment gateway percentage processing fee. Leave empty if you do not want to include any percentage amount.

After every field has been set up, click on Save & Close button at the top to save the payment plugin configuration.

Now Coinpayments payment method will start showing on the frontend subscription form, ready for visitors to choose it as their preferred payment method.

If you wish to test out the Coinpayments setup before going live, kindly follow this guide on the Coinpayments blog.

At this stage, we assume you have downloaded and installed the Membership Pro Perfect Money payment plugin and now on the Components => Membership Pro => Payment Plugins page.

Click on the os_perfectmoney payment plugin link to open the configuration page for the Perefect Money payment plugin.

Below are detailed explanations for the various configuration fields on the page.

• (1) Title

  Enter the name that you would like to show in the frontend for the Perfect Money payment method.

• (2) Published

  Select Yes if you would like to show this payment method in the frontend subscription form under payment methods; otherwise, select No.

• (3) Icon

  If you want to show a logo instead of the payment method's title on the frontend subscription form, then upload the logo to YOUR_SITE_ROOT/media/com_osmembership/assets/images/paymentmethods/ folder and enter the name of the file here. For example, os_perfectmoney.png.

  We have designed and uploaded some sample logos which you can login and download from the download page.

• (4) Perfect Money Merchant Account

  Login into your Perfect Money account (https://perfectmoney.is/) and locate My Accounts block on the page.

  
  

  
  Under My Accounts block, you will find your Perfect Money USD and EUR account numbers. USD account starts with letter "U" while EUR account starts with letter "E".

  Depending on which currency you listed your plans in or wish to convert to, copy the right account number and paste it into the Perfect Money Merchant Account field in your plugin settings.

• (5) Perfect Money Alternate Passphrase

  Next, click on Settings link on top of the page to generate your Alternate Passphrase.

  On the Perfect Money Settings page, scroll down to Alternate Passphrase field and click on Generate button to generate and copy your account's Alternate Passphrase.

  
  

  
  After, enter the turing number and click on Apply Changes button at the bottom of the page to save the settings on the Perfect Money website.

  Then paste the copied Alternate Passphrase into the Perfect Money Alternate Passphrase field in your plugin settings.

• (6) Perfect Money Receiver Name

  Enter name you wish to have displayed as the receiver name on the Perfect Money payment form. If empty, the site name saved in the configuration settings will be used.

• (7) Payment Processing Fee (Fixed - $)

  Enter payment gateway fixed processing fee. Leave empty if you do not want to include any fixed amount.

• (8) Payment Processing Fee (Percentage - %)

  Enter payment gateway percentage processing fee. Leave empty if you do not want to include any percentage amount.

• (9) Currency Conversion Needed

  Perfect Money only supports USD and EUR currencies. Therefore, if your site plans are listed in any other currency, there is need to convert it to either USD or EUR before passing it to Perfect Money for processing.

  Select No if plans are listed in either of the supported currencies, USD and EUR, or select Yes if plans are listed in an unsupported currency that needs to be converted to either USD or EUR. Default setting is No.

• (10) Preferred Perfect Money Currency

  Select the preferred supported currency that you wish to collect payment in. This will be the currency sent to Perfect Money for payment.

  Make sure the currency you select here corresponds with the account number type provided under Perfect Money Merchant Account field.

• (11) Plans Currency to Preferred Currency Conversion Rate

  Enter your website plans listed currency to preferred currency conversion rate.

  This rate will be used to multiply plan gross price before passing the resulting amount to Perfect Money in the currency selected under Perfect Money Preferred Currency field.

  Be sure to update this when your rate changes.

After every field has been set up, click on Save & Close button at the top to save the payment plugin configuration.

Now Perfect Money payment method will start showing on the frontend subscription form, ready for visitors to choose it as their preferred payment method.