Test Mercury Connection
POST/api/mercury/instances/:instance/test-connection
Test the connection for a Mercury instance.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
A successful test also refreshes the stored Mercury accounts and their balances. It also re-checks the token's permissions. Mercury has no endpoint that lists a token's permissions, so each is checked with a harmless call; the payment checks use a recipient that does not exist, so no money can move.
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 — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
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.