Overview
Solidgate provides connectors to popular software providers to facilitate seamless, fast, and up-to-date integration, allowing businesses to manage online transactions efficiently.
WHMCS
WHMCS Website is an automation platform that simplifies and automates all aspects of running an online web hosting and domain registration business.
To integrate Solidgate with the WHMCS platform, you’ll need to upload the required files, connect the application, and configure the settings.
Upload files to WHMCS
Transfer the following files from the provided archive into the /modules/gateways/ directory of your WHMCS system:
- /modules/gateways/solidgate
- /modules/gateways/solidgate.php
- /modules/gateways/solidgategw
- /modules/gateways/solidgategw.php
Additionally, move all files from the /modules/gateways/callback/ into the /modules/gateways/callback/ directory.
Connect application
Navigate to the Apps & Integration menu, Browse the available options, and choose Payments.
In the application’s menu, select:
- Solidgate for form-based payments
- Solidgate (Merchant) to support stored card payments
Click the Manage button in the displayed window and proceed with the configuration steps.
Configuration application
On the configuration page, input the required
Guide
Learn to authenticate API requests and fix validation errors effectively.
credentials
:
- Public key - the public key of your channel keys.
- Secret key - the secret key for signature generation. It is provided at the moment of merchant registration.
If needed, enable 3D payments and confirm your settings by clicking the button.
WooCommerce
WooCommerce Website , the leading e-shop platform, caters to online stores of all sizes. With low costs and quick setup using budget-friendly templates and plugins, it offers customization to meet specific requirements.
For the WooCommerce integration, we have a separate module, which you just need to import into WordPress, set the Webhook endpoint in
Solidgate
HUB
, and add your
Guide
Learn to authenticate API requests and fix validation errors effectively.
API and Webhook keys
, and start processing payments.
First, we will send the module (zip file), and then you need to import the module on your side and configure it to receive payments.
Set the Webhook Endpoint
To configure the Webhook Endpoint, navigate to Hub → Developers → Channels, and select the Channel for which you wish to set the endpoint.
Click on Add New, choose Events - Updated Card Order, and set the Webhook Endpoint URL
- your_site/?wc-api=solid_hook&type=order.updated
Module setup
Follow these steps to set up the module:
- Navigate to WordPress → Plugins → Add New, Upload Plugin, Upload file and activate
- Go to WooCommerce → Settings and open the Payments section.
Find the ‘Visa/Mastercard’ method, click on it, and access the configuration page.
On this page, provide the following information:
- Title - payment method name visible to users
- Merchant - Merchant name displayed on the payment page
- Description - method description for users
- Public Key - your API public key api_pk
- Secret Key - your API secret key api_sk
- Webhook Public Key - your webhook public key wh_pk
- Webhook Secret Key - your webhook secret key wh_sk
Click Save changes once all fields are completed.
Refund processing
Refund in WooCommerce:
- Go to WooCommerce → Orders and open the order details, where you will see the Refund button. After you click on it, just fill in the refund amount and click on Refund via Visa/Mastercard
Refund in HUB:
- Go to Hub → Payments → Orders and find the needed order (order_id and email can be found at the WooCommerce → Order Details → Order Notes), open the order, and you will be able to make a Refund by clicking the Refund button
The payment page automatically populates information from the checkout page and products in the cart, including the order name, product name, and quantity.
Payment page
The payment page retrieves data for completion from the shopping cart (order name and list of products with their quantities) and the Merchant field configured in the module settings.
Upon completion, the user will be redirected to the Payment page, which displays the following details:
- Merchant
- Order name in the cart
- Products list with quantity for each
PayPal
Shopify
Discover the effective solution to enhance revenue and provide additional value to customers through Solidgate + Shopify billing, offering easy upsell flows and quick implementation for maximizing revenue potential.
Process breakdown
- User makes a purchase on your website via Solidgate using their card data
- After the purchase, you offer an upsell of your predefined physical goods (e.g., t-shirts, books, etc.)
- The user agrees to the upsell, and you perform the purchase using a Solidgate token
- After the successful payment, the user will be redirected to a permalink you created earlier (it will be passed within the success URL)
The permalink will display the predefined physical goods and further instructions for the user. - The user places an order
- You receive a webhook notification from Shopify
- You send a request to mark the order as paid
Implementation flow
Setting up manual payment method
A. Access your Shopify account and go to Settings
B. Click on Payments
C. In the Manual payment methods section, select Add manual payment method
D. Click on Create custom payment method, then set the name for the new method, such as “I have already paid,” if your payments are processed through Solidgate
Creating cart permalink
Generate a cart permalink that redirects users to a page displaying the items they paid for along with instructions. You can find detailed information on this step here.
Adding a webhook endpoint
Set up a webhook endpoint to receive notifications when an order is created. Follow the guide to do so.
API Configuration
Creating a transaction for an order
To update your order from Pending to Paid via API, you need to send a request to create a transaction for such an order. Please refer to the documentation and the next step.
Receiving access token
A. Click on Settings in your Shopify account
- Choose Apps and sales channels
- Go to Develop apps
- Click on Allow custom app development
- Select Create an app
- Enter the app’s name and click Create app
B. Configure admin API scopes
- Choose Order editing scope
You can also choose any other scopes you want to access via API - Click Save to apply the selected scopes
C. Receive API credentials
- Navigate to the API credentials tab
- Select Install app to get an access token
- Make sure to save the token, as it will be shown only once
D. Order status
Now, you’ll be able to send an API request to change the order status from Pending to Paid.
Upsell flow example
Following these steps and processing payments with Solidgate allow you to effectively implement Shopify as an option to make upsells and potentially increase your revenue by offering additional physical goods to customers who agree to the upsell offer.
You can also take our guide with you by following the link.