@deploybaseline/square

Square emulator for local development and tests: the Square API 2026-09-16 with payments (sandbox test nonces, delayed capture), refunds, orders with server-computed totals, customers, the catalog, locations, and merchants, idempotency keys, OAuth with scopes per endpoint, and webhook subscriptions with signed events.

Part of Baseline: local drop-in replacement services for CI and no-network sandboxes.

Usage

npx @deploybaseline/cli start --service square

Square starts only when named in config or with --service. In tests, start it from code:

import { createEmulator } from "@deploybaseline/cli";
import { SquareClient } from "square";

const square = await createEmulator({ service: "square" });

const client = new SquareClient({ token: "EAAAl-baseline-square-token", baseUrl: square.url });

await square.close();

Documentation

• Square docs: auth, test values, payments, refunds, orders, catalog, OAuth, webhooks, and seed config
• API reference: http://localhost:3999/docs/square while the CLI runs (how it works)

License

Apache-2.0