Skip to main content
GET
/
v1
/
sessions
Get Session By Caller
curl --request GET \
  --url https://api.trymaven.com/v1/sessions \
  --header 'Authorization: Bearer <token>'
{
  "session_id": "<string>",
  "status": "<string>",
  "is_terminal": true,
  "amount": "<string>",
  "currency": "<string>",
  "mode": "<string>",
  "caller": "<string>",
  "project_slug": "<string>",
  "gateway": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "processor": {
    "card_brand": "<string>",
    "card_last4": "<string>",
    "receipt_url": "<string>",
    "stripe_charge_id": "<string>",
    "stripe_payment_intent_id": "<string>",
    "payment_method_id": "<string>",
    "stripe_customer_id": "<string>",
    "authnet_transaction_id": "<string>",
    "authnet_auth_code": "<string>",
    "authnet_response_code": "<string>",
    "authnet_avs_result_code": "<string>",
    "authnet_cvv_result_code": "<string>",
    "authnet_cavv_result_code": "<string>",
    "authnet_network_trans_id": "<string>",
    "authnet_capture_status": "<string>",
    "authnet_customer_profile_id": "<string>",
    "authnet_payment_profile_id": "<string>",
    "braintree_transaction_id": "<string>",
    "braintree_customer_id": "<string>",
    "braintree_payment_method_token": "<string>",
    "shift4_charge_id": "<string>",
    "shift4_customer_id": "<string>",
    "shift4_card_id": "<string>"
  },
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "description": "<string>",
  "callback": "<string>",
  "memory": "<string>",
  "transfer_status": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

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

Query Parameters

caller
string
required

Phone number in E.164 format

Response

Successful Response

Full response for session details (GET endpoint).

session_id
string
required

Session UUID

status
string
required

Session status

is_terminal
boolean
required

Whether the session has reached a final state

amount
string
required

Amount to charge

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currency
string
required

Currency code

mode
string
required

Payment mode

caller
string
required

Phone number in E.164 format

project_slug
string
required

Project slug

gateway
string
required

Payment gateway

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

processor
Processor · object

Payment processor details

error
ErrorDetail · object

Error details when status is payment-failed

description
string | null

Charge description

callback
string | null

Callback phone number

memory
string | null

Call context passed back on transfer

transfer_status
string | null

Outcome of post-payment transfer-back dial

expires_at
string<date-time> | null

When the session expires if unused

completed_at
string<date-time> | null

When the session reached a terminal state