WHMCS Square Gateway

WHMCS Square Gateway

Developed By Best PHP Scripts

Compatible with WHMCS v8.0

Now Introducing the Square Gateway Module for WHMCS

10/28/20: Square 2.2.0 has been released, with compatibility for WHMCS 8x.

As of Version 2.0.0, Recurring Payments and Refunds are supported

This WHMCS module will allow you to integrate Square with WHMCS. By enabling the module, you will be able to select Square Gateway in WHMCS, and will need to enter your developer API credentials, which can be requested for free from https://squareup.com/us/en/developers

Upon purchase, you will receive the square gateway files. Simply put everything as required into the modules file, although square.tpl will go into your WHMCS template folder. You will be able to click Addon Modules and Enter your License Key. IF you do not enter your license key, the form will not show, as your license would not show valid.

Upon validation, and inputting your API credentials, you will be able to select your Square Store Location, and will be able to officially take payments through the gateway. There is a SANDBOX mode with SANDBOX Credentials, so you will be able to TEST the module before accepting official payments through square.

It is also important to note, that a legal WHMCS license is required. If you are found with an INVALID WHMCS license, we may suspend your license for the use of the gateway.

An Installation Service is offered for purchase for assistance with installing the module!

New Licensing Structure allows for Monthly and Owned Licenses, along with changes in support & updates duration and pricing!



5 stars
4 stars
3 stars
2 stars
1 star

Shane @shane3049

January 25, 2021 at 10:41:59 PM

This was a 5 star plugin when it worked. The dev has vanished though and the sites are all down so the add-on no longer authenticates and does not work. Hope the dev is okay but would not recommend buying this plugin right now.

Edit the dev is okay! So is working on getting it all back up :D

  • 2 days ago
  • Edited

Dominic Adamson @dominic301

December 30, 2020 at 12:07:54 AM

I'm trying to download this again but your website is down, I remember it being decent.

  • 4 weeks ago

Andrew Sailors @andrew2821

December 1, 2020 at 07:30:35 PM

This module would be better if it kept the clients/guests on your website when entering credit card details. Is there a way to do this?

Michael Foland @michael5932

December 21, 2020 at 01:22:05 AM

Hello @andrew2821,

Currently, once the client goes to the payment page the form shows. I will talk to our Development team to see the best way to implement this. If you head to our website at https://mybeastportal.com I would love it if you can submit a support ticket, and we can proceed from there!

Owner@Best PHP Scripts  
  • 1 month ago

John Dough @area9232

November 24, 2020 at 07:26:45 AM

great module addon.
Fantastic support from Michael Foland

Michael Foland @michael5932

December 21, 2020 at 01:22:42 AM

Hello John! Thank you for the kind review. We are all up for suggestions on how to make the module improved!

Owner@Best PHP Scripts  
  • 2 months ago
  • Version Number 2.2.0

Mohamed Magdy @mohamed1244

October 18, 2020 at 11:51:54 PM

i try to use your module but i see every time fraud ? on the demo request and when i try to pay for a month ?

Michael Foland @michael5932

October 29, 2020 at 11:05:36 PM

Hello Mohamed,

I'm just seeing this Review. We have your Trial Account set up, and you are active in our system. I'll set you up a License, and you will be able to pay your invoice. Write a ticket if this doesn't work and I'll help you out!

I am truly sorry for any inconvenience this may have caused you!

Sincerely Yours,

Owner@Best PHP Scripts  
  • 3 months ago
  • Version Number 2.1.1

Amit @amit9638

October 12, 2020 at 10:01:08 PM

The website has been down for over a week causing my whmcs instance to be slow and the module to not work.

Michael Foland @michael5932

October 12, 2020 at 10:03:16 PM

Hello Amit! Thank you for the review. Please let us know if you have any suggestions.


Owner@Best PHP Scripts  
  • 3 months ago
  • Version Number 2.0.0
  • Edited

Ellis @ellis8577

September 27, 2020 at 10:20:40 PM

Best module ever. Micheal is extremely helpful with issues that we have had, and he has worked hard to resolve them.

Hands down the best customer service ever

Michael Foland @michael5932

September 27, 2020 at 10:24:08 PM

Hello Ellis!

Thank you for your review! I remember one of your most requested features were the Recurring Payments! I'm glad we completed that addition. As always, we are here to assist clients with their needs.


Owner@Best PHP Scripts  
  • 4 months ago
  • Version Number 1.14

Mr. PC @mr5599

July 20, 2020 at 11:37:21 AM

This plugin is not a good match with WHMCS. The description does not make it clear but you cannot use the square plugin the way you are using other gateways in WHMCS. For example, if you are a hosting company that is planning to replace your current gateway (authorize for example) with this plugin don't even think about it. You cannot "auto" charge any clientele. No need to keep cards on file anymore. Another very disappointing aspect of this plugin is this. If you create an invoice and your client has a credit card on file, you can't attempt a capture with this plugin on the invoicing page.

I brought these issues to the attention of the developers and was told that they will try to make modification to the plugin to actually make it work with WHMCS. I felt cheated. Asked for a refund and have been told that "their policy" is no refunds. Well, the plugin should work as a gateway. That is how it is sold. But it doesn't work like that at all. I deserve a refund and could care less what their policy is. If their policy is to cheat customers then they win. When I asked the developers to give me a refund now and then I can buy it again when they get it working...same answer. They won't refund my money. So I basically just gave them over $200 for nothing. I could have wiped my butt with it and flushed it. Same result.

This plugin is very, very disappointing and does not work like any other gateway. It is misleading and shouldn't even be an option to buy in this forum.

Michael Foland @michael5932

August 22, 2020 at 07:38:30 PM

Hello Mr. PC,

Can you please contact us through our website? We are in the process of developing recurring payments. This has not been very feasible with Square, but there are some new things that have been added to Squares API. As far as a refund, we can work out credits on the account, but the module works as expected right now, except for recurring payments. We have also worked on the design aspect of the form. Please contact us, and we'll be glad to talk over this with you.


Owner@Best PHP Scripts  
  • 6 months ago
  • Version Number 1.12

Jacob Adams @jacob4361

April 23, 2020 at 05:16:15 AM

This plugin is amazing, absolutely affordable for smaller businesses getting into the Hosting world. Very nice and easy to access customer support. Fast responses with real answers to questions. Not a lot of back and forth or misunderstanding. They know what they are doing over there at Beast! I am very happy to be a client of theirs. I was worried that I was going to have to switch merchant providers as the other companies price point was so high it didn't fit into my budget. But I found these guys and I couldn't be happier. Taking payments is smooth and efficient with no glitches or issues. I wish all of my services were this easy and conflict free. Thanks guys, keep up the great work.

Michael Foland @michael5932

September 27, 2020 at 05:25:23 AM

Hello Jacob! I wanted to thank you for the amazing comment, and I wanted to take the time to reply, and let you know that our Payment Gateway now supports recurring payments and refunds!

Owner@Best PHP Scripts  
  • 9 months ago
  • Version Number 1.1.0
  • Edited

Paul Tracy @paul1319

April 6, 2020 at 06:41:23 AM

Owner is really nice and kind. Fixed my issue pretty fast considering how hard it was to fix. And low price and great support

Michael Foland @michael5932

September 27, 2020 at 05:26:17 AM

Hello Paul! Thank you for the amazing Comment! I wanted to reply to this and let you know that our Payment Gateway now supports Recurring Payments and Refunds!

Owner@Best PHP Scripts  
  • 9 months ago
  • Version Number 1.0.8

Keith Read @keith8681

December 13, 2019 at 04:52:08 PM

Is this app dead? Their website said they will have a new site will be online in October 2019 plus their client portal has a dead link.

Michael Foland @michael5932

December 14, 2019 at 07:48:51 PM

Hello, Keith! If you go to https://mybeastportal.com you will be able to get the app! I'm not sure why the client portal is dead. Here is the direct link: https://mybeastportal.com/cart.php?gid=10

Thank you,
Mike Foland
Beast Web Services

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.8

Kamlesh @kamlesh2747

October 18, 2019 at 05:33:45 AM

No comment provided.

Michael Foland @michael5932

November 8, 2019 at 10:25:30 PM

Thank you for the 4 star rating! If there's anything we can do to improve the payment gateway, please let us know.

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.7

Steven Dey @steven6394

October 2, 2019 at 03:01:48 AM

No comment provided.

Michael Foland @michael5932

November 8, 2019 at 10:25:49 PM

Thank you for the 5 star rating! If there's anything we can do to improve the payment gateway, please let us know.

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.7

Bhagwan Sahane @Logicmaker

September 15, 2019 at 11:44:07 AM

I think this module is no more updated with recent API updates and also not compatible with SCA requirements.
Might be @mfoland is not aware of this updates from payment gateway.

Let us know if anyone wants help regarding the same.

- Logicmaker

Nicholas Sansom @nicholas6920

September 18, 2019 at 03:36:50 AM

Hi Bhagwan,

Thanks for your reply. I am pleased to inform you that we are actually in the process of revamping and enhancing our version of Square Gateway, and in fact we intend to soon offer two versions of this module. V1 - Single payments and V2 - Single and Recurring payments.

Please stay tuned for our next release.

Kindest Regards,

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.7

Ian Turner @ian7070

June 16, 2019 at 05:02:23 AM

I have been looking for a Square payment gateway for a long time and finally, BestPHP Scripts has built one. I started off with the trial and was so happy with it, I purchased the full license right away. I was having some issues with my WHMCS (not related to this module), and Michael from BestPHP Scripts went above and beyond to help me so I could get things working properly and get my square payment gateway setup. Top-notch product & support. I highly recommend this module to anyone who accepts square payments. Well worth the money.

Michael Foland @michael5932

August 5, 2019 at 07:34:14 PM

Hello Ian,

Thank you SO MUCH for your review! We really appreciate it, and we are planning some new updates as well! Let us know if you have any issues or suggestions :)


Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.5

Charles Yarbrough @WebHostPro

February 22, 2019 at 07:13:03 AM

I just added this and was able to take a payments right away. Works perfectly and looks great in my checkout. I had no idea how cool Square was. Glad I did it.

Michael Foland @michael5932

February 22, 2019 at 07:15:52 AM


Thank you so much for your review! If you have any suggestions, etc, you are more than welcome to send us an email! Enjoy :)

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.1

Bryan Alderson @bryan4633

February 14, 2019 at 07:15:46 PM

The payment gateway I've been waiting for. I'd nearly given up on Square integration when I couldn't even get a pre-sales response from the other Square gateway vendor.

The team from Best PHP Scripts went above and beyond to ensure my Square integration was up and running with the minimum of fuss.

Great responsive support I couldn't have asked for more.

Cannot recommend the team at Best PHP Scripts enough!

Michael Foland @michael5932

February 15, 2019 at 01:44:55 AM


Thank you so much for your review! We're glad to help!

Owner@Best PHP Scripts  
  • 1 year ago
  • Version Number 1.0.0

Version Compatibility

Compatible with WHMCS v8.0

Full Version Compatibility

  • Selected versions of WHMCS v8.0
        8.0.0 - 8.0.3
  • All versions of WHMCS v7.10
  • All versions of WHMCS v7.9
  • All versions of WHMCS v7.8

System Requirements

  • Square Developer & Merchant Account
  • Valid Legal WHMCS License
  • WHMCS Version 7.9.0 and greater
  • PHP 7.1 & greater

* Requirements listed are in addition to the WHMCS default system requirements.

Support for this product

The best place to start if you need help with a specific product is to contact the developer. All WHMCS Marketplace developers have both a website and support URL listed.

Developed By Best PHP Scripts


v2.3.0 Released November 24th, 2020

Latest Version

Square 2.3.0 Changes (Released 11/24/20)

  • Fixed reported Currency Conversion Issues where Invoices were not getting paid where there was one currency
  • Eliminate PHP 5.6 from requirements as it is EOL and not recommended.

More Information found on our Release Announcement Page.



Previous Versions

v2.2.0 Released October 28th, 2020

View/hide detailed changelog

Square 2.2.0 Changes (Released 10/28/20)

  • Made Compatible for WHMCS 8x
  • Backwards Compatible for WHMCS 7x
  • Create Permissions for Sub-Users to access invoicing if allowed set by primary Account Owner
  • Overhaul manage.php to work with Account Creation on SquareUp
  • Fixed Add Credit Card API
  • Fix Remove Credit Card where Cards were not removing from WHMCS
  • Fix Gateway Code to use $params or $GatewayConfig parameters dependent on invoice rather than using Laravel due to encryption with WHMCS 8x
  • Clean source Code
  • Ensure Remote Capture and Refunds work with new code

More Information found on our Release Announcement Page.



v2.1.1 Released October 12th, 2020

View/hide detailed changelog

#Version 2.1.1 Changelog

  • Fix error with adding and displaying saved Credit Cards due to API lookup issue
  • Fix support for installations that choose not to do Currency Conversion

#Planned Update Roadmap

*Multiple Domain Support


v2.1.0 Released October 10th, 2020

View/hide detailed changelog

#Version 2.1.0 Changelog

  • Fix Currency Conversion issues by adding a convertCurrency function
  • Fix manage.php and add_submit.php for card retrieval and add issues
  • Move Charge Card on File form outside of square form as this was causing issues.


v2.0.0 Released September 27th, 2020

View/hide detailed changelog

#Version 2.0.0 Changelog

  • Fixed Bootstrap Charge Form for One-Off Payments
  • Create hooks.php in includes folder of WHMCS. (If this is deleted, features of Square will be missing)
  • Added Functions to View, Add and Remove Credit Card for Recurring Payments. Square does NOT allow Editing Credit Cards with the API.
  • Used DeletePayMethod API in WHMCS to allow deletion of Cards so that Administrators don't need to remove for the customer
  • Add function to WHMCS to store Gateway Token for grabbing data with API call upon Charge Request with Attempt Capture Button (Uses AddPayMethod Class)
  • Add functioning Capture Function and Button
  • Enable Capture Function to send an email if Card was Declined or Approve
  • Added Code to properly log failure notices on Attempt Capture
  • Ensure Cron Jobs work with Capture Attempts
  • Add Link for Manage Square Credit Cards under Billing in the Client Area
  • Add Action Hook for Manage Square CC Information in Client Area HomePage
  • Add Action Hook using ClientAreaHeadOutput to change URI for the Add Credit Card Button in Billing > Manage Pay Methods to override the default Credit Card Form
  • Implement Banners for phasing out earlier versions of PHP and WHMCS for later versions of Square
  • Implement a fully functional trial, where ALL Addons work (done with Square 1.15)
  • Implement a Developer Key where all functions will work, but banners will be used as this mode is strictly for testing
  • Edit License.php to make Developer Mode fully functional, where Addons work
  • Edit License.php to fix Update Banner to include a spot for notes and a link to the announcement or kb article containing notes about the newest release
  • Add Banner letting know if an update was available for Square (Requires Active Support & Updates Package)
  • Add Banners for a Sandbox mode
  • Added Banner on Recurring page to warn Payments are Recurring as per Squares recommendation (Might be customizable in later versions)
  • Added option to select a Card on File to Charge with one-off payment form
  • process-ccof.php Works successfully with v2 Payments using Curl instead of API
  • Fixed System Url on square.php to prevent double slash in public URI
  • Eliminate process-card.php which used the Square API. ChargeCard.php uses cURL to allow for easier development and expansion
  • Support for Refunds
  • Cleaned up code


  • Dispute Center in Admin > Modules> bws_square for Disputes (Addon License)
  • Multiple Domain Support


v1.14 Released August 21st, 2020

View/hide detailed changelog

Bug Fixes

  • Fixed square bootstrap form to fix form values and javascript to allow processing. This was an oversight in 1.13.
  • Added API directly to form as a failsafe for location pulling.
  • Added API directly to process-card.php as it was not grabbing the location correctly through WHMCS.
  • These corrections fixed the errors reported via support tickets.


v1.13 Released August 13th, 2020

View/hide detailed changelog

Version 1.13 Changes

  • Enhance Form Customization Option
  • Enhance Branding Removal Option with HTML Editor for Branding
  • Make Payment Form Bootstrap to support any WHMCS Theme
  • Move Licensing Banners into License.php
  • Allow Trial Licenses to be fully functional with Branding Removal and Form Customization
  • Write New Install Instructions to Website
  • Add WHMCS Version compare to prepare for WHMCS 8.0.0 as PHP 7.3 and greater will only be accep


  • Recurring Payments
  • Recurring payments is in the works, and is currently being designed. This will allow the use of the Attempt Capture and will store Credit Card Data via Square and NOT WHMCS.
  • Create New Licensing Tiers


v1.12 Released May 2nd, 2020

View/hide detailed changelog

Version 1.12 Changes

  • Allow Customization of Payment Form
  • Moved Branding Addon to Addons Section
  • Added protocol in Licensing to check the server for new updates, and display a message


  • Support for Recurring Payments (Will create a save card while waiting on API) -- Top Importance
  • Create New Licensing tiers.


v1.1.0 Released April 5th, 2020

View/hide detailed changelog

Version 1.1.0 Changes

  • Fix API to work with new API Key format, and URL's
  • Fixed API URL's (Both sandbox and Operational)
  • Fixed ApiClient and Configuration to host new URL's
  • Cleaned Payment Gateway section to move Licensing to Addon (Current clients will need a license refresh)
  • Fix Payment Form so that Sandbox and Operational correctly get card nonce
  • Allow detection of correct currency that is set in WHMCS
  • Ensure PCI compliance is working and ensure that form is tokenized. (Form does not save ANY card data to WHMCS Database)
  • Clean up square.php to ensure payment processing works smoother.
  • Allow ProcessCard and API pages to correctly use Capsule to get Sandbox and operational modes, along with current currency and payment amount.


  • Support for Recurring Payments (Will create a save card while waiting on API) -- Top Importance


v1.0.8 Released October 31st, 2019

View/hide detailed changelog

Version 1.0.8 Changes

  • Fix API Urls
  • Ensure PCI Compliant
  • Fix Card Nonce and Processing Issues


  • Support for Recurring Payments (Will create a save card while waiting on API) -- Top Importance
  • Overhaul the API
  • Move Licensing to a Module
  • Allow WHMCS to use Attempt Capture (Depending on API)


v1.0.7 Released September 13th, 2019

View/hide detailed changelog

Version 1.0.7 Changes

  • Fix Licensing Server to new location
  • Fix Currency to show correct Currency, and send new Currency to the gateway.


  • Support for Recurring Payments (Will create a save card while waiting on API)
  • Overhaul the API
  • Move Licensing to a Module
  • Allow WHMCS to use Attempt Capture (Depending on API)


v1.0.6 Released September 6th, 2019

View/hide detailed changelog

Version 1.0.6 Changes

  • Remove the requirements for smarty php tags to be required by creating a single .tpl file which links into the php files to control the operations of square.
  • Move License to a folder to control licensing
  • Move License Key input into WHMCS Admin
  • Remove the need for the $installDir tag, which is now automatically detected.
  • Allow Custom Branding to be added (requires Branding Addon)
  • Add Notification for new version if client has Support & Updates Package
  • Add to Instructions Sandobx requires the use of Legacy Key in Developer Mode.


  • Support for Recurring Payments (Will create a save card while waiting on API)
  • Overhaul the API


v1.0.5 Released May 23rd, 2019

View/hide detailed changelog

Version 1.0.5 Changes

  • Addition of onclick event to disable submit button once pressed to prevent double charges
  • Update instructions to note that currency code and country code can be changed as needed if conversion somehow fails in WHMCS.


v1.0.4 Released May 6th, 2019

View/hide detailed changelog

Version 1.0.4 Changes

  • Cleanup index.php and process-card.php
  • Continued to test using unique id for idempotency issues discussed in Version 1.0.3 -- RESOLVED
  • Repair process-card.php - Customers were receiving 500 errors after submitting CC details. Fixed PHP versioning issues/ directory file naming bugs.


v1.0.3 Released May 2nd, 2019

View/hide detailed changelog

Version 1.0.3 Changes

  • Idempotency Key changed from string to unique id.

The idem key was not correctly changing the key each time, and was allowing transactions to fail. With this change, when you refresh the invoice the key will change, thus allowing the charge to go through correctly. The idem key does prevent duplicate charges! Those that download a 30 day trial, or have an Owned License and have a VALID Updates Subscription will be able to receive this update!

For those with a current license, make sure you do not replace license-key.php as it will override your license and you will need to re-add the license key. You also do not need to update square.tpl to your template directory.


v1.0.2 Released March 12th, 2019

View/hide detailed changelog

Hotfixes to fix the following:

  • License Validation Structure
  • Directory Structure for WHMCS installs not in a root folder. You will be able to edit square.tpl to specify your folder name
  • Hot Fix to allow below PHP 7. This will also work with lower versions of the IonCube Loader as well.


v1.0.1 Released February 20th, 2019

View/hide detailed changelog


  • process-card.php was giving a corrupt error with IonCube. After reviewing the code, comment styles have been fixed, and this version fixes the corrupt file issue. If you have any issues, please contact us, and we'll be glad to assist!


v1.0.0 Released February 2nd, 2019

View/hide detailed changelog

Initial Release


See also

WHMCS Bitcoin Payments

Accept Bitcoin payments on your website

Accept Bitcoin and 50+ Cryptocurrencies - CoinGate for WHMCS

Easily accept Bitcoin, Litecoin, Ether and many other altcoins on your WHMCS website

Coinbase Commerce

No Fees, Easy Setup. Accept cryptocurrencies like: Bitcoin, Bitcoin Cash, Ethereum and Litecoin!


bKash Payment module. bKash is most popular mobile payment system in Bangladesh.


Integrate Paytm Payment Gateway and accept payments using any payment method - Credit / Debit Cards, UPI, Netbanking, Paytm Wallet, EMI and many more.