square-check

Instant Square payment diagnostics — see failed payments, refund leaks, disputes, and problem locations.

Usage

npx square-check

Credentials are auto-detected from:

• SQUARE_ACCESS_TOKEN environment variable
• .env, .env.local, .env.development, .env.production files

Or pass directly:

npx square-check --token <access-token>

Get your access token at: https://developer.squareup.com/apps

Modes

| Flag | Description | |------|-------------| | (default) | 🚨 Overall payment health check | | --loss | 💸 Total revenue lost | | --declines | 📊 Failure breakdown by reason | | --recovery | 🔁 Recovery rate | | --customers | 👤 Affected customers | | --locations | 📍 Problem locations (Square-specific) | | --refunds | 💰 Refund analysis | | --disputes | ⚖️ Open disputes & exposure | | --invoices | 📄 Overdue invoices | | --subscriptions | 🔄 Failed subscriptions | | --webhooks | 🔔 Webhook event coverage | | --spike | ⚠️ 24h failure spike detection | | --products | 📦 Losses by item/note |

Environment Variables

• SQUARE_ACCESS_TOKEN — Square API access token (production or sandbox)
• SQUARE_TOKEN — Alternative name for the access token

Learn More

Visit squarerecover.com for full breakdown and automated recovery tools.