Pay Connectors

Create a Pay connector

Changed on

Create a generic payment connector in the authenticated organization. The name must be unique in that organization. Authentication supplies ownership; do not send user_id or organization_id. Config is encrypted at rest; passwords and tokens are omitted from responses. This operation stores configuration and does not initiate a payment. See the processor contract.

post/pay_connectors

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/pay_connectors
  • Auth: HTTP bearer

Request body

namestring required

Unique within the authenticated organization. Used in resource paths and as connector_name in the Call Control Pay request. Cannot be renamed by update.

type'generic'

Connector type covered by this reference.

mode'test' | 'live'

Defaults to test on creation. Test restricts collected card numbers but still contacts the configured processor; use a processor sandbox URL and sandbox credentials. Live removes the test-card restriction. Neither mode locks API updates.

Example request

{
  "name": "my-payment-connector",
  "config": {
    "endpoint_url": "https://processor.example.com/pay"
  }
}

Response

Connector created. Credentials are omitted.

Example response

{
  "data": {
    "config": {
      "endpoint_url": "https://processor.example.com/pay"
    }
  }
}

Changes