Skip to main content
POST
cURL

Query Parameters

api_token
string
required

API token to authenticate the request

Body

application/json
caller
string
default:+16151231234
required

Phone number of the caller (your customer)

Response

Response

caller
string

Phone number of the caller (your customer)

description
string
default:Reservation for two at The Gourmet Bistro, 7:30 PM on December 30th, 2024, Table 12, Indoor seating, Special request: Window view, Confirmation number: 12345

Details about the purchase

price
string
default:10.00

Price of the item (in USD), e.g. 10.50

vendor
string
default:example-co

Who this payment should be sent to - please refer to the /vendors page to find the full list

customer_id
string
default:""

To specify the processor-specific customer ID (if you have it). Only used if processor is Authorize.net.

persona
string
default:english-jessica

Which voice to use - currently available: 'english-jessica'

callback
string
default:+14155552671

Phone number to hand the call back to after the payment is processed, e.g. +14155552671

email
string<email>
default:my_customer@company.com

Email of the caller (your customer)

full_name
string
default:John Doe

Name of the caller (your customer)

transaction_type
enum<string>
default:once

How to process the transaction

Available options:
once,
subscription,
authorize
memory
string
default:""

Literally anything. Typically used to share information across agents.

status
string
default:payment-success

How the call went

start_time
string
default:2024-12-30T02:59:32.213280+00:00

When the call was initiated.

processor
object

dynamic response that is unique to the payment processor

debug
string
default:""

Any misc details to help debug issues