Connect the payment gateway
Saves or replaces the business's GoPay credentials, the same as connecting the gateway in the
administration (needs the PRO plan, 403 TIER_REQUIRED otherwise). The credentials are stored encrypted
and are never returned. Sandbox credentials are refused (400 with field environment) where the
platform does not allow a test gateway. Replacing credentials resets the verification. Audited with the API
key as the actor. Requires the payments:manage scope and an Idempotency-Key header.
ApiKeyAuth payments:manageAuthorizationBearer <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:manage
Idempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64application/json- body
provider*"GOPAY"The payment provider.
"GOPAY"environment?string"PRODUCTION""PRODUCTION""SANDBOX"gopay*The new 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 PUT 'https://api.shyni.io/api/v1/payments/gateway' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "provider": "GOPAY", "gopay": { "goid": "string", "clientId": "string", "clientSecret": "string" }}'Response 200
The new 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 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}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 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}