Skip to content

Get a processor connection

The processor_connections.get operation: GET /api/v1/processor_connections/{id} in the REST API and the processor_connections_get tool in the MCP server.

GET/api/v1/processor_connections/{id}

Returns one processor connection (pcon_…) of the entity: status, key hint, publishable key, account, webhook endpoint and last event, and the last connection test. Keys and secrets are never returned. Connections of another entity or mode are resource_not_found.

At a glance

  • REST: GET /api/v1/processor_connections/{id}
  • MCP tool: processor_connections_get
  • Operation ID: processor_connections.get
  • Scope: Legal entity
  • Permission: processors:read
  • Risk tier: read
  • Dry run: Not supported
  • Idempotency: Not needed (read only)
  • Modes: Test and live
  • Authentication: API key with the processors:read scope
  • Since: M4

Request

Path parameters

FieldTypeDescription
idpcon_… ID

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

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

Examples

A Stripe connection

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

Response (200):

JSON
{
  "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
}

Errors

CodeHTTP statusWhenWhat to do
resource_not_found404No such connection for this entity in this mode.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
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: validation_failed, api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.