Skip to Content

Square Payment Provider

by
Odoo

$ 45.56

v 19.0 Third Party
Versions 17.0 18.0 19.0
You bought this module and need support? Click here!
Versions 17.0 18.0 19.0

Key Features

Take Square payments in Odoo — hosted Payment Links checkout, full & partial refunds, and signed webhooks that reconcile themselves

Hosted Payment Links

Customers pay on Square's secure hosted checkout and return to Odoo — no card data ever touches your server.

Full & partial refunds

Issue full or partial refunds straight from the Odoo transaction through the Square Refunds API — no dashboard hopping.

Signed webhooks

Every payment.* and refund.* event is verified with HMAC-SHA256 — only authentic Square callbacks are processed.

Idempotent settlement

Odoo re-fetches the authoritative payment or refund from Square before settling, so a repeated event never double-processes an order.

Self-healing reconcile

An hourly cron reconciles any webhook Square missed and polls async refund status, so no payment is left in limbo.

Sandbox & production

Flip between Square sandbox (Test) and live (Enabled) — the correct host and keys are used automatically.

One-click validation

Validate Configuration and Test Connection check your keys and location live, with a clear health badge and message.

Gateway logs

Turn on opt-in per-transaction request/response logging to debug integrations — off by default to keep data lean.

Lightweight & standard

Depends only on Odoo's core payment app — no Enterprise, no extra SaaS — and plugs into the standard provider flow.

Payment Provider
Square listed and enabled among the Odoo payment providers.
Credentials
Square credentials: access token, application ID, location ID, webhook signature key and Test/Enabled environment.
Configuration
Configuration tab: payment methods, supported currencies (USD, EUR, GBP, AUD, CAD, JPY, CNY, HKD) and availability.
Checkout
Square offered as a payment option at checkout, redirecting to the hosted Square Payment Links page.
Transaction & Diagnostics
A completed Square transaction with the Square Diagnostics panel: payment link, order and payment IDs, COMPLETED status, refund ID and gateway logs.

User guide

Enter your Square keys, point the webhook back at Odoo, and start taking payments — with full and partial refunds and self-healing reconciliation built in.

1. Enter your Square credentials

  1. Open Accounting → Configuration → Payment Providers → Square.
  2. Paste your Access Token, Application ID and Location ID from the Square Developer Dashboard.
  3. Set the environment to Test (Square sandbox) or Enabled (production).

2. Wire up the webhook

  1. In the Square Dashboard, add a webhook pointing to /payment/square/webhook on your Odoo domain.
  2. Subscribe to the payment.* and refund.* events and copy the Signature Key into the provider.
  3. Click Validate Configuration, then Test Connection — the health badge confirms you are ready.

3. Go live & refund

  • Publish the provider; customers now pay on Square's hosted checkout and return to Odoo automatically.
  • Issue full or partial refunds from the payment transaction whenever you need to.
  • The hourly reconcile cron cleans up any missed webhook and polls async refund status for you.

Frequently Asked Questions

1. Do I need Odoo Enterprise or an extra service?
No. The module depends only on Odoo's core payment app and works on Odoo Community — no Enterprise licence and no third-party middleware.
2. Which checkout flow does it use?
Square's hosted Payment Links (redirect). The customer pays on Square's secure page and is returned to Odoo — no card data touches your server.
3. Does it support refunds?
Yes — both full and partial refunds via the Square Refunds API, issued directly from the Odoo payment transaction.
4. How are webhooks kept secure?
Every callback is verified with HMAC-SHA256 against your Square Signature Key, so only authentic payment.* and refund.* events are processed.
5. What happens if a webhook is missed?
An hourly reconcile cron re-fetches the authoritative payment or refund from Square. Settlement is idempotent, so nothing is double-processed and nothing is left pending.
6. Can I test in a sandbox first?
Yes. Set the provider to Test to use the Square sandbox host and keys, then switch to Enabled for production — the module picks the right host for you.
7. Which currencies are supported?
The currencies on Square's allow-list: USD, CAD, GBP, AUD, EUR, JPY, CNY and HKD. Orders in other currencies simply won't offer Square at checkout.
Module Support & SLA
For support related to this module, contact apps@odooerp.ae
Standard response time (SLA) for support queries is typically 1 to 2 working days.
+971 54 289 8664 Email Us
Oakland partner and services
Support and contact information
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies Discuss (mail)
Lines of code 984
Technical Name oe_payment_square
LicenseOPL-1
Websitehttps://odooerp.ae 
Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.