Square App Overview

The Saleor Square App is a payment gateway integration that lets customers pay for their checkouts online using Square.

Square is a payments and commerce platform used by sellers to accept payments online and in person. This app covers online (card-not-present) payments made on your storefront. In-person payments with Square Terminal are handled by a separate app and are not covered here.

Features

The Square app integrates the Saleor Transactions API with the Square Payments API and Orders API. On the storefront, payment details are collected with the Square Web Payments SDK.

The app:

• Is configured through the Saleor Dashboard UI
• Lets you create multiple Square connections (for example, sandbox and production) and assign them to specific Saleor channels
• Creates one itemized Square Order per Saleor checkout, built from the checkout lines and shipping, so Square receipts and reports show what was bought
• Charges payments immediately (charge flow)
• Supports cards, Apple Pay, Cash App Pay, Afterpay/Clearpay, and Square gift cards
• Supports paying part of the total with a Square gift card and the rest with another method
• Supports saving cards for logged-in customers and paying with saved cards
• Supports refunds from the Saleor Dashboard
• Supports canceling a gift card authorization from the Saleor Dashboard
• Sets up the Square webhook subscription from the app UI
• Reconciles payment and refund status updates sent by Square, including refunds made in the Square Dashboard
• Reports configuration problems to the Saleor Dashboard

Limitations

Before installing this app, review these limitations to ensure they don’t conflict with your requirements.

• The app supports only the charge flow. Set the channel’s transaction flow to CHARGE. If a payment would be authorized instead, transactionInitialize fails with CHARGE_FAILURE and the UNSUPPORTED_TRANSACTION_ACTION error code. Storefronts can’t override the channel setting. The only exception is a split payment with a Square gift card: when the gift card covers part of the total, Saleor records AUTHORIZATION_SUCCESS until the rest is paid.
• Only one Square gift card can be used per checkout.

Next steps

Explore the app’s architecture or proceed to the configuration guide.