Get a store's payment-handler configuration

Which handlers are enabled and their (non-secret) configuration status. Secrets are never returned.

GET/stores/{store_id}/payment-config

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Path parameters

store_idstringrequired

A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Responses

200

Payment configuration.

store_idstring

handlersobject[]

Show properties

Array of object

handler_idstring

namestring

enabledboolean

configuredboolean

All required parameters/secrets present.

config_statusstring

Allowed:not_startedincompleteready

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

store_idpath*A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Request

curl -X GET "https://api.sarvex.example.com/v1/stores/string/payment-config" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.sarvex.example.com/v1/stores/string/payment-config", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.sarvex.example.com/v1/stores/string/payment-config",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "store_id": "string",
  "handlers": [
    {
      "handler_id": "google_pay",
      "name": "com.google.pay",
      "enabled": true,
      "configured": true,
      "config_status": "not_started"
    }
  ]
}