Skip to main content
POST
/
v1
/
sessions
Create Session
curl --request POST \
  --url https://api.trymaven.com/v1/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": "<string>",
  "caller": "<string>",
  "amount": 1,
  "description": "<string>",
  "callback": "<string>",
  "memory": "<string>"
}
'
{
  "session_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "phone_number": "<string>",
  "sip_uri": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.trymaven.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Enter your API key: mvn_test_xxx or mvn_live_xxx

Body

application/json

Request to create a payment session.

project
string
required

Project identifier (UUID or slug)

caller
string
required

Phone number in E.164 format

amount
required

Amount in dollars (e.g. 150.00; must be > 0 for charge mode)

Required range: x >= 0
mode
enum<string>
required

Payment mode: 'charge' or 'tokenize'

Available options:
charge,
tokenize
gateway
enum<string>
required

Payment gateway: 'stripe', 'authorizenet', 'braintree', or 'shift4'

Available options:
stripe,
authorizenet,
braintree,
shift4
description
string | null

Charge description

Maximum string length: 500
callback
string | null

Callback phone number or SIP URI for transfer-back

Maximum string length: 256
memory
string | null

Call context passed back on transfer

Response

Successful Response

Minimal response after creating a session.

session_id
string
required

Session UUID

status
string
required

Session status

created_at
string<date-time>
required

Creation timestamp

phone_number
string | null

IVR phone number to call

sip_uri
string | null

Twilio SIP domain for SIP calls