API ReferenceEndpointsCheckoutList payment providers

List payment providers

Lists every payment provider enabled for the store, with the public data needed to render each payment option. It always reports hasPayments: true with a synthetic sandbox entry; to detect an unconfigured store use the 503 of payment/intent.

GET
/vc/{connectionId}/payment/providers
X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Header Parameters

originstring

Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

curl -X GET "https://api.brainerce.com/api/vc/string/payment/providers" \  -H "origin: string" \  -H "X-SDK-Version: string"
{
  "hasPayments": true,
  "providers": [
    {
      "id": "clinst_abc123",
      "provider": "stripe",
      "name": "Stripe",
      "publicKey": "pk_live_...",
      "stripeAccountId": "clstripeaccount_abc123",
      "supportedMethods": [
        "string"
      ],
      "testMode": false,
      "isDefault": true,
      "methodType": "CREDIT_CARD",
      "presentation": "card_form",
      "isAdditive": false,
      "supportsSavedCards": false,
      "clientSdk": {
        "renderType": "sdk-widget",
        "displayModes": [
          "sdk-widget"
        ],
        "scriptUrl": "string",
        "globalName": "string",
        "initMethod": "string",
        "renderMethod": "string",
        "containerId": "string",
        "initConfig": {},
        "renderArg": "string",
        "additionalScripts": [
          {
            "url": "string",
            "optional": true
          }
        ],
        "bodyStyles": "string",
        "embeddedFieldsUrl": "string",
        "embeddedFieldsSessionId": "string",
        "embeddedFieldsProvider": "cardcom"
      }
    }
  ],
  "defaultProvider": {
    "id": "clinst_abc123",
    "provider": "stripe",
    "name": "Stripe",
    "publicKey": "pk_live_...",
    "stripeAccountId": "clstripeaccount_abc123",
    "supportedMethods": [
      "string"
    ],
    "testMode": false,
    "isDefault": true,
    "methodType": "CREDIT_CARD",
    "presentation": "card_form",
    "isAdditive": false,
    "supportsSavedCards": false,
    "clientSdk": {
      "renderType": "sdk-widget",
      "displayModes": [
        "sdk-widget"
      ],
      "scriptUrl": "string",
      "globalName": "string",
      "initMethod": "string",
      "renderMethod": "string",
      "containerId": "string",
      "initConfig": {},
      "renderArg": "string",
      "additionalScripts": [
        {
          "url": "string",
          "optional": true
        }
      ],
      "bodyStyles": "string",
      "embeddedFieldsUrl": "string",
      "embeddedFieldsSessionId": "string",
      "embeddedFieldsProvider": "cardcom"
    }
  }
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/payment/providers"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/payment/providers"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/payment/providers"
}