---
title: "Retrieve a Pay connector"
method: GET
path: "/pay_connectors/{name}"
tags: ["Pay Connectors"]
---

# Retrieve a Pay connector

`GET /pay_connectors/{name}`

## Request

- Base URL: `https://api.telnyx.com/v2`
- URL: `https://api.telnyx.com/v2/pay_connectors/{name}`
- Auth: HTTP bearer

Retrieve a connector by name within the authenticated organization. Password and token are omitted. A missing name or a connector owned by another organization returns 404.

## Path parameters

- `name` string, required

## Response `200`

Connector details with credentials omitted.

- PayConnectorResponse
  - `data` PayConnector: Organization-owned connector. Examples and config properties here describe generic connectors; listing is not restricted to that type unless filter[type]=generic is supplied. Passwords and bearer tokens are omitted, not masked. Defaults for auth_type and timeout need not appear in stored config.
    - `id` string, uuid: Connector identifier.
    - `name` string: Connector name used for retrieval, update, deletion and Pay.
    - `record_type` 'pay_connector': Resource type.
    - `user_id` string: Creating user; assigned from authentication, not request input.
    - `organization_id` string: Owning organization; assigned from authentication, not request input.
    - `type` string: Connector type; generic is covered by this reference. Other types may appear in unfiltered lists.
    - `mode` 'test' | 'live': Configured mode.
    - `config` object: Redacted stored configuration. Generic connector fields are shown here. Unknown config keys are discarded. Password and token are never returned.
      - `endpoint_url` string: HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in transit.
      - `auth_type` 'none' | 'basic' | 'bearer': Stored processor authentication selection. Omitted if it was not explicitly configured.
      - `username` unknown
      - `timeout` integer: Stored processor HTTP timeout in milliseconds. Omitted when no timeout was configured; the effective runtime default is 10000.
    - `created_at` string, date-time: Creation time.
    - `updated_at` string, date-time: Last update time.

## Other responses

- `404`: Connector not found in the organization.

## Changes

> 152 revisions in range; 1 not diffed.

- **2026-10-23** `05f96b352898`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/changes/pay_connectors/:name/get.md)

---

[API](https://skmtc.dev/team-telnyx/apis/telnyx-api-2.md) - [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/revisions/f82938f53ff4?raw)