Test connection
POST/api/square/instances/:squareIntegrationInstance/test-connection
Call /v2/merchants/me on Square using the stored access token. Latches the returned merchant_id onto the instance if it isn't already set.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Requires the integrations.sync permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.