Skip to main content
A voice session (vos_*) collects one open payment intent over one phone call. To learn more, see Take a payment over voice and Call log and transcripts.
Voice is in early access and subject to change. To request Voice access, contact hi@natural.com.

Example

GET /voice/sessions/{voiceSessionId}
The object is everything inside data. The field names below are relative to it: attributes.kind is data.attributes.kind in the response.

Fields

string
required
Voice session ID (vos_*).
string
required
Resource type. Always voiceSession.
object
required
kind is the session’s purpose and names the block that holds its result. New kinds may be added; ignore kinds you don’t handle.
object
required
Related resources, each by type and ID.

Statuses

Permissions

Create needs both voiceSessions.create and paymentIntents.create, Voice enabled on your account, and an active Accept application for the business you collect for. List, get and the transcript need voiceSessions.read.

Events

  • voiceSession.completed: A voice session closed as ended, expired, or canceled. Sent once per session. canceled and expired can arrive a few minutes late. A paid call whose call end never arrived closes as expired with payment.outcome paid. It does not mean paid. Read payment.outcome: paid, linkSent when voice payment did not succeed and the caller was texted the payment link, or unpaid. The payment intent is the source of truth for money, and delivery order is not guaranteed.

Errors

See the error codes these endpoints return.

Sandbox simulations