PMPro
Introduction
PMPro (Paid Membership Pro) is the most comprehensive WordPress Membership Plugin. It allows content restriction and management of member subscriptions with recurring payments, including user registration, custom profile fields, and robust member management. In addition, it offers efficient tools that the merchant will need to start, manage, and grow their membership site. Merchant can add the BillDesk PMPro plugin for accepting seamless payments through PMPro.
Merchant can download the plugin with the following link.
Prerequisites
In the merchant's PMPro dashboard, ensure that merchant has downloaded, installed, and configured:
- Paid Membership Pro version 3.4.7
- PHP version 8.1
Integration Steps
Follow the steps below to install and activate the BillDesk PMPro plugin.
Installation
The plugin can be installed in two ways:
-
Uploading the plugin from the admin panel:
- In Plugins→ Add New→ Add Plugins→ Upload Plugin
- Choose the PMPro plugin file and click Install Now
-
Manually installing the plugin in WordPress:
- Extract the shared plugin archive file and copy it to wp-content/plugins/ folder within the WordPress deployment.
Activation
- Click on Activate Plugin
- Installation Successful!
Plugin Configuration
After the plugin is activated, the merchant will see a Memberships tab in the sidebar. To configure the plugin, navigate to Memberships → Settings → Payment Gateways & SSL.
Note: Ensure that the merchant has obtained the necessary details like Merchant ID, Merchant Key, etc. from BillDesk.
The configuration page looks as below:
- Payment Gateway - string - Select “BillDesk” from the drop-down list.
- Merchant Id - string - This is the unique ID created by BillDesk to identify the merchant.
- Client Id - string - A client ID shared by BillDesk for accessing the Payment Gateway APIs.
- Key ID - string - The unique identifier of the public key shared by BillDesk
- Encryption Password - string - An encryption key that is used to protect the communication with Payment Gateway APIs.
- Signing Password - string - A signing key that is used to protect the communication with Payment Gateway APIs.
- Currency - string - The currency code (ISO 4217) for the currency to be used in the payment. For Indian Rupees, use code 356.
- Merchant Logo - string - A URL or Base64 encoded logo of the merchant that will be visible on the payment page.
- To convert image into Base64 encode image, use the following reference link - https://www.base64-image.de/
- Logo image does not have any specific requirements. Any image that is supported by browsers img tag can be used.
- Item Code - string - The item code as shared by BillDesk.
- Payment Category - string - This option allows configuring payment categories. Suppose a merchant only wants to show cards as a payment option. Then it can be controlled using this configuration. All allowed payment methods need to be mentioned separately by a comma.
Note that since the payment method name can be dynamic, there is no validation for this input at this moment.
Valid payment category codes are as follows:
| Code | Payment Category |
|---|---|
| card | Credit/Debit Card |
| emi | EMI |
| upi | UPI |
| wallets | Wallets |
| qr | QR Code |
| gpay | Google Pay |
-
Retry Count - number - Controls the number of payment re-attempts that should be allowed to users on failed payment.
-
Child Window - number - Enables or disables the child window.
- True/Enabled - If it is enabled, the modal opens the bank's page for processing in another window.
- False/Disable - If it is disabled, the modal redirects the merchant page to bank URLs for processing.
-
Environment - string - Enables switching between the UAT or Production environments. Depending on this configuration, the plugin will connect to the UAT or production URLs.
-
TEST PG CONNECTIVITY - Confirm the successful configuration by clicking on 'Test PG Connectivity'. If the configuration was not successful, check Troubleshooting for error code analysis.
- Click Save Settings.
SuccessAfter configuring the settings mentioned above, merchant can start accepting payments via the BillDesk Payment Integration!
Features
Payment
Membership Plan
- In the merchant's site, click the Membership Account tab.
- Select the desired Membership plan and click SUBMIT and CHECK OUT to proceed with payment.
- Merchant will be redirected to the BillDesk Payments page.
- The user flow is depicted in the screenshots below:
Order Listing
View Orders
- Merchant can view the Order History in the Memberships→ Orders tab.
- Merchant can view reports in the Memberships→ Reports tab. Merchant can also find the reports under the Memberships option.
Troubleshooting
For PMPro, logs can be viewed at logs/pmpro-billdesk-yyyy-mm-dd.log, where we can check for the reason of failure.
To confirm that the PG connection is established, go to the Configuration page and click on TEST PG CONNECTIVITY.
Case 1: PG connectivity is successful.
Case 2: PG connectivity is unsuccessful.
If an error occurs during the connection, please refer to the following table:
| Error Code | Error Type | Error Description |
|---|---|---|
| GNAUE0006 | authentication_error | Request from unauthorized IP. |
| ORIRE0001 | invalid_request_error | Required parameter Merchant ID is missing. |
Updated 8 days ago
