Reading list Switch to dark mode

    PrestaShop Square Payment Gateway

    Updated 19 December 2023

    PrestaShop Square Payment Gateway – Permits you to sell product subscriptions and accept recurring payments via Square payment gateway. Order normal or subscription product via Square payment.

    Note: PrestaShop Square Payment module is compatible with 3D SCA(Strong Customer Authentication), multishop and PrestaShop version 8.x.x.

    • Accept payments via Card, Wallet and ACH Bank via Square for non subscription products.
    • Offer product subscriptions and accept recurring payments using Pay by Card via Square.
    • Make refund of orders (without Subscription) paid via Square.
    • View list of customers subscribed for the products.
    • View all transactions done through Square Payment Gateway.

    Important Note:

    SSL must be enabled to use this module.
    PHP version 7.1 or greater is required to use this module.
    Supported countries for Square payment account:
    – USA
    – Australia
    – Canada
    – Japan
    – United Kingdom
    – Ireland
    – France
    – Spain

    Features of the PrestaShop Square Payment Gateway module

    • The subscription amount deducts from the customer’s account, as per the subscribed plan.
    • Subscription is only possible through Card payment.
    • Admin can use the module either in sandbox or production mode, as per the requirement.
    • Provide the API keys according to the mode selected.
    • Create the subscription plan on store itself.
    • Admin need to specify the plan frequency & time period (till which the plan will be active) of the subscription plan.
    • Admin can also edit/delete the subscription plan.
    • Assign created plan to products.
    • Admin can assign products with or without combinations to the subscription plan.
    • Admin can update/delete the assigned plan from the product.
    • View the separate list of transactions made through Square Payment Gateway.
    • Admin can either refund full or partial amount to customer for their orders done without subscription.
    • While refunding the partial amount, admin can specify the amount less than or equal to the amount paid by buyer.
    • View the list of subscribed customers.
    • Cancel the subscription of any customer.
    • Customer can view the subscription details on product page.

    How to install the Prestashop Square Payment Gateway module

    • Firstly, go to the module manager in back office and click on ‘upload a module’.
    • After that, drag and drop the module file or select the file from the system.
    • In this way, the module installation will be successful.

    How to configure the Prestashop Square Payment Gateway module

    After successful installation, an admin can configure the module.  Admin will need to provide certain details to configure the module like app ID, access token, location Id, and Webhook signature key.
    Will explain to you the process to obtain these keys below.

    Start your headless eCommerce
    Find out More

    Subscription product message: This is the message that will display on the Subscription product page so configure accordingly.

    Payment Options: The selected ones will appear on the front end for the customers to make payments.
    Here is something to note, for the subscription products only the Pay by Card payment option will be available however, for the products without subscription all the payment options that are selected will be available.

    Webhook Settings: In this section, you will need to enter the Webhook signature key if you want to get updated transaction details.


    Let’s now understand the process to obtain app Id, access token, location Id and Webhook signature key

    For, app ID and Access token, go to and create app.


    For Location Id, open the app and click on “Location” option on the left.


    And, to get Webhook signature key, open the app and click on “Webhooks -> Subscriptions” option on the left. After that click on a webhook, a window in the right will appear from where you can copy the Signature key.


    Back end View

    After successful installation, new tabs get added in the back office. We will discuss the functionality of each tab in detail.


    Subscription Plans

    Here appears the list of plans that admin creates.
    Furthermore, you can add plans and edit or delete a particular plan.


    Add Plan

    The admin will need to provide Plan Name, Plan Frequency and Plan period till which it will be activated.


    Once the plan is created, it will appear in the list as shown here


    Edit Plan

    Plan details can be edited from the Edit Plan page.


    Subscription Product

    Subscription plans assigned to the products will appear here. From this section, you can assign plan to the products.
    Let us see the process.


    Assign Plan

    1- Select Plan
    2- Choose Product, and Save


    If a product has combinations,
    1- Select Plan
    2- Choose Product
    3- Choose Combinations, and Save


    Upon Saving, it will appear in the Subscription Product list.


    Front-End Flow

    On the product page, a customer will see whether a product is subscription-based or not. On visiting the product page, the detail related to the subscription plan is also visible to them.

    Customer can choose the Subscribe option to subscribe for a product.


    If the customer add to cart the subscription product then on the cart page he will see a subscription product tag/label that will indicate that the product is a subscription products and furthermore, if the customer need then he can also remove the subscription from the cart page itself and proceed with buying that product as normal product without subscription.


    Once the customer proceed to purchase the product, the Square payment gateway will be available to purchase the subscription-based product. The customer will have to enter the Card details in order to proceed.


    If the customers pay via 3D Secure Card, they will be asked to enter their secret static code to confirm the order.

    SCA Authentication

    Order created by the customer. On the order confirmation page, the customer can see the payment details.


    If the customer has purchased a non subscription product then all the payment methods that are allowed by the admin will appear on the front end.

    Payment options


    The list of subscription created by the customer is shown in this tab. The admin can View the details of the transactions as well as if want then the admin can also cancel the subscription of a particular customer.


    View Transaction



    Under this tab, all the transactions done through the Square Payment Gateway will appear.
    We have added a column of “Payment Type” that will help you to distinguish whether the order is a subscription order or it is one time.

    To view complete details of the Transaction, the admin can click on “View” button.



    Here the admin can see the complete transaction details.


    As Refund is possible with the module however, the admin cannot make the returns of the subscription orders.
    The Refund option is only available for the one time purchase orders done via Square Payment.

    View the Transaction details of any One time Purchase order and the admin will see the Refund option under that. From here the admin can make a refund partially or fully.


    After the refund is done, its listing will appear in the Refund list section.


    Front End View

    The customer can view the list of their subscription in the new tab. Go to My Account -> My Subscription.


    On clicking the Square Payment Subscription, the complete subscription list of the customer will appear.
    The Customer can cancel the subscription at any point of time.

    transaction details

    This was all about Prestashop Square Payment Gateway Module. I hope this document will help you in checking the functionality of the module in a better way. Also, do let us know about your views in the comments.


    For any kind of technical assistance or query, please raise a ticket or send us a mail at [email protected]

    Also, please explore our Prestashop development services and a vast range of quality Prestashop addons.

    Current Product Version - 4.0.1

    Supported Framework Version - 8.x.x, 1.7.x.x

    . . .

    Leave a Comment

    Your email address will not be published. Required fields are marked*

    Be the first to comment.

    Back to Top

    Message Sent!

    If you have more details or questions, you can reply to the received confirmation email.

    Back to Home

    Table of Content