Skip to content

List processor connections

The processor_connections.list operation: GET /api/v1/processor_connections in the REST API and the processor_connections_list tool in the MCP server.

GET/api/v1/processor_connections

Lists the legal entity's processor connections in the mode of the request, newest first: processor, label, status, the key hint (never the key), the webhook endpoint and when the last event arrived, and the last connection test. Filter by processor and status; paginate with limit (1–100, default 10) and starting_after.

At a glance

  • REST: GET /api/v1/processor_connections
  • MCP tool: processor_connections_list
  • Operation ID: processor_connections.list
  • Scope: Legal entity
  • Permission: processors:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Pagination: limit (at most 100) and starting_after
  • Authentication: API key with the processors:read scope
  • Since: M4

Request

Query parameters

FieldTypeRequiredDescription
limitinteger (1 to 100)No
starting_afterpcon_… IDNo
processorone of stripe, mollie, fakeNo
statusone of active, degraded, disconnectedNo

Response

200 OK with a JSON object, a page of the list (newest first):

FieldTypeDescription
object"list"
dataarray of object
data[].idpcon_… ID
data[].object"processor_connection"
data[].entityIdent_… ID
data[].livemodeboolean
data[].processorone of stripe, mollie, fake
data[].labelstring
data[].statusone of active, degraded, disconnected
data[].statusReasonstring or null
data[].accountIdstring or null
data[].keyHintstring
data[].publishableKeystring or null
data[].checkoutComponentone of stripe_payment_element, redirect, fake
data[].webhookobject
data[].webhook.modeone of managed, manual
data[].webhook.urlstring
data[].webhook.endpointIdstring or null
data[].webhook.lastEventAtdate-time or null
data[].lastTestobject
data[].lastTest.okboolean
data[].lastTest.missingPermissionsarray of string
data[].lastTest.messagestring or null
data[].lastTest.checkedAtdate-time
data[].failuresobject or null
data[].disconnectedAtdate-time or null
data[].createdAtdate-time
data[].updatedAtdate-time
data[].versioninteger (at least 1)
has_moreboolean
next_cursorpcon_… ID or null

Examples

The entity's connections

HTTP
GET /api/v1/processor_connections
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "object": "list",
  "data": [
    {
      "id": "pcon_01m4vyt4mxe0s9zzk90373z6p7",
      "object": "processor_connection",
      "entityId": "ent_01m4ttwd3veh9apbewxheq5xh4",
      "livemode": false,
      "processor": "fake",
      "label": "Fake processor",
      "status": "active",
      "statusReason": null,
      "accountId": "acct_fake_0123456789abcdef",
      "keyHint": "fake_…9f2c",
      "publishableKey": null,
      "checkoutComponent": "fake",
      "webhook": {
        "mode": "managed",
        "url": "http://localhost:3000/api/webhooks/fake/pcon_01m4vyt4mxe0s9zzk90373z6p7",
        "endpointId": "we_fake_0123456789abcdef01234567",
        "lastEventAt": null
      },
      "lastTest": {
        "ok": true,
        "missingPermissions": [],
        "message": null,
        "checkedAt": "2026-10-14T12:00:00.000Z"
      },
      "failures": null,
      "disconnectedAt": null,
      "createdAt": "2026-10-14T12:00:00.000Z",
      "updatedAt": "2026-10-14T12:00:00.000Z",
      "version": 1
    },
    {
      "id": "pcon_01m4vyt4mxe0s9zzk90373z6p6",
      "object": "processor_connection",
      "entityId": "ent_01m4ttwd3veh9apbewxheq5xh4",
      "livemode": false,
      "processor": "stripe",
      "label": "Stripe",
      "status": "active",
      "statusReason": null,
      "accountId": "acct_1ExampleAccount01",
      "keyHint": "rk_test_…AbCd",
      "publishableKey": "pk_test_ExampleOnlyNotARealKey000000000AbCd",
      "checkoutComponent": "stripe_payment_element",
      "webhook": {
        "mode": "managed",
        "url": "https://ownrecord.io/api/webhooks/stripe/pcon_01m4vyt4mxe0s9zzk90373z6p6",
        "endpointId": "we_1ExampleEndpoint01",
        "lastEventAt": null
      },
      "lastTest": {
        "ok": true,
        "missingPermissions": [],
        "message": null,
        "checkedAt": "2026-10-14T12:00:00.000Z"
      },
      "failures": null,
      "disconnectedAt": null,
      "createdAt": "2026-10-14T12:00:00.000Z",
      "updatedAt": "2026-10-14T12:00:00.000Z",
      "version": 1
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A filter or pagination value is invalid.Fix the fields listed in details.issues and send the request again.
scope_required400The request names no legal entity.Call the operation with credentials or a target at its level: an organization, a legal entity, a brand or the platform (details.required_scope).
permission_denied403You can't see processor connections here.Ask an organization owner or admin for a role or scope that allows this action.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, resource_not_found, dry_run_not_supported, rate_limited, internal_error.