Square is a user-friendly payment gateway designed to help businesses accept payments quickly and securely. With seamless integration into EasyStore, Square allows store owners to manage payments effortlessly and provide a smooth checkout experience for their customers.

Square supports payments in 8 countries worldwide. Refer to the complete list of supported countries for more information.

Adding Square to Your Payment Options

• Log in to your Joomla Dashboard and navigate to Components > EasyStore > Settings > Payments.
• Within Payment Settings, locate the “Add Payment Method” button and click on it.
• From the list of available payment methods, choose Square and click on the “Add” button.

This action will successfully add Square to the list of available payment options for your online store.

Configuring Square Integration

Once you have added Square to your payment method list, click on the "Setup" button right beside the Square payment method.

This action will prompt a pop-up screen to appear, allowing you to configure the plugin according to your preferences.

Title

Give your Square integration a title (e.g., "Square"). This user-defined title helps you identify this integration within your Joomla Dashboard.

Payment Environment

Choose between the "Test" or "Live" payment environment depending on whether you want to test payments in a demo/test environment or process real transactions in a live environment.

How to Obtain Test Application ID, Test Access Token, and Test Location ID

To integrate the Square payment gateway in EasyStore and get the Test Application ID, Test Access Token, and Test Location ID, follow these steps:

• Create a Square Developer Account
  Go to the Square Developer Portal and sign up or log in.
• Create a Sandbox Application
  In your developer dashboard, go to the “Application” section from the sidebar. Click on the “+” sign to create a new application. Give it a Name and complete the corresponding steps to create a new application.

• Get Test Application ID and Access Token
  Once you have created the application, you will find the Sandbox Application ID and Sandbox Access Token in the “Credentials” section. 

You can switch between the Sandbox and Production environments to access the credentials for each mode.

• Find Test Location ID

In the same application dashboard, navigate to the Locations section to find your Location ID.

• Use These Credentials in EasyStore
  Enter the Test Application ID, Test Access Token, and Test Location ID into EasyStore’s Square payment integration settings to start testing payments in sandbox mode.

How to Obtain Webhook Subscription ID

To obtain webhooks, navigate to and expand the Webhooks section and click on “Subscriptions”. From there, please follow these steps:

• Click on Add subscription

• Enter a Subscription name and a valid Notification URL for your domain.

• Scroll down to the Events and select the specific events for which you want to receive notifications. However, you must choose the "Payments" events for smooth operation. Click on the Save button to add the webhook subscription. 

• You will now find it on the dashboard. Once you click on the webhook, you will find the Subscription ID and Signature Key. Copy and paste these into the relevant fields on your EasyStore settings.

How to Obtain Live Application ID, Test Access Token, and Test Location ID

Start by creating your merchant account and an application following the steps outlined above. Once you’re in the application dashboard, go to the Credentials section and switch to Production mode. Here, you will find your Live Application ID and Production Access Token. Then, navigate to the Locations section to get your Live Location ID.

Payment Instruction

If necessary, provide your customers with any payment instructions or additional information. This could encompass details on completing a payment or any special instructions regarding Square payments.

After configuring the above settings, click Save & Close to save the integration. 

To make the Square payment method available for your online store, you need to add it to your list of payment methods from EasyStore > Settings > Payments. Learn more.