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.
GET
/
pay_connectors
/
{name}
JavaScript
import Telnyx from 'telnyx';const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted});const PayConnector = await client.payConnectors.retrieve('name');console.log(PayConnector.data);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
pay_connector = client.pay_connectors.retrieve(
"name",
)
print(pay_connector.data)
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.payConnectors().retrieve("name");
}
}
require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
pay_connector = telnyx.pay_connectors.retrieve("name")
puts(pay_connector)
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$pay_connector = $client->payConnectors->retrieve(
'name',
);
var_dump($pay_connector);
} catch (APIException $e) {
echo $e->getMessage();
}
Connector name, not its UUID. URL-encode the name as a path segment.
Example:
"my-payment-connector"
Response
Connector details with credentials omitted.
data
object
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.
Show child attributes
Was this page helpful?
JavaScript
import Telnyx from 'telnyx';const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted});const PayConnector = await client.payConnectors.retrieve('name');console.log(PayConnector.data);
import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
pay_connector = client.pay_connectors.retrieve(
"name",
)
print(pay_connector.data)
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
var response = client.payConnectors().retrieve("name");
}
}
require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
pay_connector = telnyx.pay_connectors.retrieve("name")
puts(pay_connector)
<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$pay_connector = $client->payConnectors->retrieve(
'name',
);
var_dump($pay_connector);
} catch (APIException $e) {
echo $e->getMessage();
}