Pay Connectors

Update a Pay connector

Changed on

Update a generic connector by name in the authenticated organization. Both test and live connectors can be updated through the API. Omitted fields remain unchanged. Supplying config replaces the entire config; it does not merge keys. Include endpoint_url and the credentials required for the selected auth_type on every config replacement. Omitting config preserves existing credentials, allowing a mode-only update. The path name cannot be renamed. Public updates use PATCH.

patch/pay_connectors/{name}

Request

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

Path parameters

namestring required
Example:my-payment-connector

Connector name, not its UUID. URL-encode the name as a path segment.

Request body

type'generic'

Generic connector type. Omit to preserve the existing value.

mode'test' | 'live'

Omit to preserve the existing mode. Use an explicit test or live value.

Example request

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

Response

Updated connector after the modeOnly example, with credentials omitted.

Example response

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

Changes