> ## Documentation Index
> Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a Pay connector

> 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.



## OpenAPI

````yaml /openapi/source/external/call-control/pay-connectors.json get /pay_connectors/{name}
openapi: 3.1.0
info:
  title: Telnyx Pay Connectors API
  version: 2.0.0
  x-latency-category: responsive
  x-endpoint-cost: light
  description: >-
    Manage generic Pay connectors. This reference covers generic processor
    configuration only. Use a Telnyx API key for these endpoints; config
    authentication applies separately to requests sent to the payment processor.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  contact:
    email: support@telnyx.com
servers:
  - url: https://api.telnyx.com/v2
security:
  - bearerAuth: []
tags:
  - name: Pay Connectors
    description: Generic payment connector configuration.
paths:
  /pay_connectors/{name}:
    get:
      tags:
        - Pay Connectors
      summary: Retrieve a Pay connector
      description: >-
        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.
      operationId: getPayConnector
      parameters:
        - name: name
          in: path
          required: true
          description: Connector name, not its UUID. URL-encode the name as a path segment.
          schema:
            type: string
            example: my-payment-connector
      responses:
        '200':
          description: Connector details with credentials omitted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayConnectorResponse'
              example:
                data:
                  id: 550e8400-e29b-41d4-a716-446655440000
                  record_type: pay_connector
                  name: my-payment-connector
                  type: generic
                  mode: test
                  user_id: user-example
                  organization_id: organization-example
                  config:
                    endpoint_url: https://processor.example.com/pay
                    auth_type: bearer
                  created_at: '2026-10-01T12:00:00.000000Z'
                  updated_at: '2026-10-01T12:00:00.000000Z'
        '404':
          description: Connector not found in the organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayConnectorErrors'
              example:
                errors:
                  - detail: Resource not found
components:
  schemas:
    PayConnectorResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PayConnector'
    PayConnectorErrors:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: Telnyx error code.
              title:
                type: string
                description: Error title.
              detail:
                type: string
                description: Error detail.
              source:
                type: object
                properties:
                  pointer:
                    type: string
                    description: Invalid field pointer.
    PayConnector:
      type: object
      description: >-
        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.
      properties:
        id:
          type: string
          description: Connector identifier.
          format: uuid
        name:
          type: string
          description: Connector name used for retrieval, update, deletion and Pay.
        record_type:
          type: string
          description: Resource type.
          enum:
            - pay_connector
        user_id:
          type: string
          description: Creating user; assigned from authentication, not request input.
        organization_id:
          type: string
          description: >-
            Owning organization; assigned from authentication, not request
            input.
        type:
          type: string
          description: >-
            Connector type; generic is covered by this reference. Other types
            may appear in unfiltered lists.
        mode:
          type: string
          enum:
            - test
            - live
          description: Configured mode.
        config:
          type: object
          description: >-
            Redacted stored configuration. Generic connector fields are shown
            here. Unknown config keys are discarded. Password and token are
            never returned.
          properties:
            endpoint_url:
              type: string
              description: >-
                HTTP or HTTPS processor URL with a host. Use HTTPS to protect
                payment data in transit.
              pattern: ^https?://\S+
              example: https://processor.example.com/pay
            auth_type:
              type: string
              description: >-
                Stored processor authentication selection. Omitted if it was not
                explicitly configured.
              enum:
                - none
                - basic
                - bearer
            username:
              description: >-
                Stored username, when supplied. Required to be a nonblank string
                for basic authentication.
            timeout:
              type: integer
              minimum: 1
              maximum: 4294967295
              description: >-
                Stored processor HTTP timeout in milliseconds. Omitted when no
                timeout was configured; the effective runtime default is 10000.
        created_at:
          type: string
          description: Creation time.
          format: date-time
        updated_at:
          type: string
          description: Last update time.
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.

````