Guide for Magento 2 SquareUp Payment Gateway

• Customers can place the order using credit/debit cards as required within the Magento 2 store.
• Webhook creation functionality from the admin panel.
• Authorize, Authorize and Capture features for the payments.
• The admin can set the title for the payment gateway visible at the storefront at checkout time.
• The admin can easily make a refund to the customers for the orders placed using the payment gateway.
• This payment gateway works in the testing and production modes.
• It supports SquareUp-supported currencies and countries.
• Magento 2 SquareUp Payment gateway is level 1 PCI-DSS compliant.

Note: This module does not work with Multiple Address Checkout.

The installation is quite simple just like the standard Magento 2 extensions.

#Download Module

Firstly, you need to log in to the Webkul Store, go to My Account>My Purchased Products section, verify, and then download and extract the contents of this zip folder on the system.

#Upload Folder

Once the module zip extracts, follow path src>app and then copy the app folder into the Magento 2 root directory on the server as shown below:

# Run Commands

You need to run the following commands:

composer require square/square

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

php bin/magento indexer:reindex

php bin/magento cache:flush

For translating the module language, navigate through src/app/code/Webkul/SquareUp/i18n and edit the en_US.csv file.

Thereafter, rename the CSV as “en_SA.csv” and translate all right side content after the comma in the Arabic language. After editing the CSV, save it.

Now, upload it to the path src/app/code/Webkul/SquareUp/i18n where the installation of Magento 2 is on the server. The module translates into the Arabic Language.

It supports both RTL and LTR languages.

The user can edit the CSV like the image below.

You can also check our complete Magento 2 plugins.

Navigate to the Squareup Portal and sign in to your account.

After login, go to the application section and tap the add button to add an app.

After tapping the add button, a pop-up appears. Enter the name of the app and tap the Next button.

Now, check the options of Accept payments and tap the Next Button.

After that choose the audience type where you are going to use the payment method and tap the complete button.

Now, the app will create and you can find the respective details for the Application ID and the Access token.

Now, in the side panel, navigate to the locations option to get the Location ID.

After successful installation of the Magento 2 SquareUp payment gateway, the admin can configure the same. Navigate through Stores->Configuration->Sales->Payment Methods->Square Up Payment Gateway.

Here, the admin will –

• Enable the payment gateway by choosing a Yes option else disable the same by selecting a No.
• Choose the Payment Mode as – Authorize or Authorize and Capture as required.
• Set the Title of the payment method.
• Choose the environment as Sandbox or Production as required.
• Enter the application ID, Access Token, and Location ID.
• Choose payment from applicable countries from where you want to accept the payments.
• Payments from specific countries – Choose if you want to take payments from specific countries only.
• Lastly, generate the Webhooks, and after that save the configuration settings.

Admin can also navigate to the configuration through the dedicated sidepanel button as per image below,

If you’re looking to create a custom e-commerce website, it’s a great idea to hire Magento developers who can help you build a powerful and scalable online store.

Note: Webhooks are essential for invoice, refund generation, and transactions history in case of both ‘Authorize’, and ‘Authorize & Capture’ payment modes.

Webhook Setup & Configuration Issues

If webhooks are not functioning properly, first verify that your server supports webhook integration.
Also, ensure the Webhook URL is correctly configured and publicly accessible.

Confirm that your server allows incoming webhook notifications from Square.
Review the Square Dashboard for any webhook configuration errors or failed delivery logs.

Testing in Sandbox mode can help identify integration issues.
It also allows you to validate webhook events before moving to production.

The customers at the storefront will add the products to the cart and move to the payment method selection section.

Here, they will select the Magento 2 SquareUp Payment Gateway enter their card details along with their zip code, and tap the Place order button.

The payment will process accordingly.

lastly, you can see a success message after the order gets placed.

The customer can navigate to the order history and check the payment method selected for the placed order.

Payment Mode – Authorize

If this configuration is set, then in this case, when the customer places the order, the invoice is not automatically generated.

The admin first needs to capture the payment and after that, the invoice is generated.

For the respective order, the admin can see the payment methods selected.

The admin can also capture the payment after realizing the payment has been credited into his account.

Tapping the capture button will capture the payment and the invoice will be generated.

Transaction details show the payment is captured with the transaction ID.

Comments history also shows the details.

Refund Process

If the admin wants to make a refund for the order, the admin can navigate to the invoice for the order and view it by tapping the View link available for the invoice.

Here, on the view invoice page, tap the Credit Memo button.

Now, tap the Refund button to return the order amount to the customer’s account that was used to make the payment.

After tapping the Refund button the refund amount gets credits back to the customer’s account. Also, the transaction details generate for the refund.

Payment Mode – Authorize and Capture

If this configuration is set, then in this case, when the customer places the order, the invoice automatically generates(payment authorizes & captures).

There is no need to capture the payment manually.

The admin can log in to the SquareUp dashboard and check the API logs for payments and refunds that have been made.

Tapping a particular API log the admin can view the API log details.

Apart from that, the admin can navigate to the transactions section as shown below to check the payments and the refund logs.

Payment information:

Refund Information:

That is all about the Magento 2 SquareUp Payment Gateway extension. If you have any queries regarding the plugin, please contact us at Webkul Support System.

You may also check our top-quality Magento 2 Payment Method Extensions