Payment gateway connection
The state of the business's payment gateway connection: provider, environment (sandbox), whether the
credentials are verified and the account label (the non-secret GoID). Never returns the client secret.
connected: false means no credentials are saved. Needs the payments:read scope.
ApiKeyAuth payments:readAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: payments:read
The connection state.
application/json- response
connected*booleanFalse when no credentials are saved; every other field is then null.
provider*|"GOPAY""SIMULATED"nullenvironment*|"PRODUCTION""SANDBOX"nullsandbox*|True for test credentials.
state*|CREDENTIALS_SAVED after a save, until the gateway confirms them.
"CREDENTIALS_SAVED""VERIFIED""ERROR"nullaccountLabel*|The connected account, without any secret.
lastVerifiedAt*|date-timelastError*|The gateway's last error message, when state is ERROR.
lastErrorKind*|"REJECTED""NETWORK"nullcurl -X GET 'https://api.shyni.io/api/v1/payments/gateway' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY'Response 200
The connection state.
{ "connected": true, "provider": "GOPAY", "environment": "PRODUCTION", "sandbox": true, "state": "CREDENTIALS_SAVED", "accountLabel": "string", "lastVerifiedAt": "2019-08-24T14:15:22Z", "lastError": "string", "lastErrorKind": "REJECTED"}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}