Collect payment details

Collect payment details from the caller using DTMF and either charge or tokenize the payment method through a configured Pay connector. Pay pauses active call recordings while sensitive payment details are collected.

When payment_token is supplied, the DTMF collection steps are skipped and the existing token is sent to the connector.

Expected Webhooks:

call.payment.progress
call.payment.completed

Test mode card numbers: 4111111111111111 (Visa), 5555555555554444 (Mastercard), 378282246310005 (American Express), 6011111111111117 (Discover), 3065930009020004 (Diners Club), 3566002020360505 (JCB), 6200000000000005 (UnionPay), and 6771798021000008 (Maestro). Test-mode connectors reject other card numbers before contacting the configured processor. The UnionPay and Maestro numbers are accepted for processor testing, but Pay currently does not emit a card type for them.

POST

calls

{call_control_id}

actions

pay

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.pay('call_control_id', {
  connector_name: 'Default',
});

console.log(response.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
)
response = client.calls.actions.pay(
    call_control_id="call_control_id",
    connector_name="Default",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Calls.Actions.Pay(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionPayParams{
			ConnectorName: telnyx.String("Default"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.calls.actions.ActionPayParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ActionPayParams params = ActionPayParams.builder()
            .connectorName("Default")
            .build();
        var response = client.calls().actions().pay("call_control_id", params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.calls.actions.pay("call_control_id", connector_name: "Default")

puts(response)

<?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 {
  $response = $client->calls->actions->pay(
    'call_control_id',
    connector_name: 'Default',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx calls:actions pay \
  --api-key 'My API Key' \
  --call-control-id call_control_id \
  --connector-name Default

curl --request POST \
  --url https://api.telnyx.com/v2/calls/{call_control_id}/actions/pay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_name": "Default",
  "amount": 10.5,
  "currency": "USD",
  "payment_method": "credit-card",
  "transaction_type": "charge",
  "max_attempts": 3,
  "timeout_millis": 5000,
  "inter_digit_timeout_millis": 5000,
  "voice": "female",
  "language": "en-US",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}
'

{
  "data": {
    "result": "ok"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

call_control_id

string

required

Unique identifier and token for controlling the call

Body

application/json

Pay request

connector_name

string

default:Default

Name of the Pay connector used to process the transaction.

Example:

"Default"

amount

number

Amount to charge. Required when transaction_type is charge.

Required range: x >= 0

Example:

10.5

currency

enum<string>

default:USD

Currency used for the transaction. Pay currently supports USD only.

Available options:

USD,

usd

Example:

"USD"

payment_token

string

Existing payment token. When supplied, payment-detail collection is skipped.

Example:

"tok_abc123"

payment_method

enum<string>

default:credit-card

Payment method to collect.

Available options:

credit-card,

ach-debit

transaction_type

enum<string>

Transaction to perform. If omitted, Pay infers tokenize when amount is absent or zero and charge when amount is positive.

Available options:

charge,

tokenize

description

string

Optional description forwarded with the payment transaction.

Example:

"Order 12345"

client_state

string

Base64-encoded state included in subsequent webhooks.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

metadata

object

Metadata forwarded to the Pay connector.

Example:

{ "order_id": "ORD-12345" }

parameters

object

Additional parameters forwarded to the Pay connector.

Example:

{ "customer_id": "CUST-67890" }

prompts

Pay Prompts · object

Custom text-to-speech prompts keyed by payment collection step.

Show child attributes

Example:

{
  "payment-card-number": [
    { "text": "Please enter your card number." },
    {
      "text": "That card number was not accepted. Please try again.",
      "attempt": "2 3",
      "error_type": "invalid-card-number"
    }
  ]
}

max_attempts

integer<int32>

default:3

Maximum number of attempts for each payment collection step.

Required range: 1 <= x <= 3

timeout_millis

integer<int32>

default:5000

Time in milliseconds to wait for DTMF input for each collection step.

Required range: 1 <= x <= 600000

inter_digit_timeout_millis

integer<int32>

default:5000

Time in milliseconds to wait between consecutive DTMF digits.

Required range: 1 <= x <= 600000

voice

string

default:female

Voice used for payment prompts. Accepts male, female, or a provider voice in <Provider>.<Model>.<VoiceId> format, for example AWS.Polly.Joanna or Telnyx.KokoroTTS.af.

Example:

"female"

language

string

default:en-US

Language used for payment prompts.

Example:

"en-US"

service_level

string

default:premium

Speech synthesis service level used for payment prompts. Pay defaults to premium.

command_id

string

Idempotency key for the command. Telnyx ignores a duplicate command with the same command_id for the same call_control_id.

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

Response

Successful response upon making a call control command.

data

Call Control Command Result · object

Show child attributes

Example:

{ "result": "ok" }

Remove call from a queue

Call payment completed

⌘I

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.pay('call_control_id', {
  connector_name: 'Default',
});

console.log(response.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
)
response = client.calls.actions.pay(
    call_control_id="call_control_id",
    connector_name="Default",
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Calls.Actions.Pay(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionPayParams{
			ConnectorName: telnyx.String("Default"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.calls.actions.ActionPayParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ActionPayParams params = ActionPayParams.builder()
            .connectorName("Default")
            .build();
        var response = client.calls().actions().pay("call_control_id", params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.calls.actions.pay("call_control_id", connector_name: "Default")

puts(response)

<?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 {
  $response = $client->calls->actions->pay(
    'call_control_id',
    connector_name: 'Default',
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx calls:actions pay \
  --api-key 'My API Key' \
  --call-control-id call_control_id \
  --connector-name Default

curl --request POST \
  --url https://api.telnyx.com/v2/calls/{call_control_id}/actions/pay \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_name": "Default",
  "amount": 10.5,
  "currency": "USD",
  "payment_method": "credit-card",
  "transaction_type": "charge",
  "max_attempts": 3,
  "timeout_millis": 5000,
  "inter_digit_timeout_millis": 5000,
  "voice": "female",
  "language": "en-US",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901"
}
'

{
  "data": {
    "result": "ok"
  }
}

Voice API Fundamentals

Voice Features

AI Capabilities

Tutorials

Regional & Restrictions

API Reference

For AI Agents

Collect payment details

Authorizations

Path Parameters

Body

Response