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.
API Reference
The Maven API is a REST API that uses JSON request and response bodies. All endpoints are served over HTTPS.
Base URL
Authentication
All endpoints require an API key passed as a Bearer token in the Authorization header:
Authorization: Bearer mvn_test_your_key_here
See Authentication for details on key formats and test vs live modes.
Endpoints
Voice Sessions
Endpoints for payments collected over phone calls:
| Method | Endpoint | Description |
|---|
POST | /v1/sessions | Create a new voice payment session |
GET | /v1/sessions | Get session by caller phone |
GET | /v1/sessions/{session_id} | Get session by ID |
POST | /v1/sessions/{session_id}/cancel | Cancel a session |
Endpoints for payments collected via the embeddable widget. See the Chat Widget quickstart for the full integration flow.
| Method | Endpoint | Description |
|---|
POST | /v1/widget-sessions | Create a new chat/web payment session |
GET | /v1/widget-sessions/{session_id} | Session details for the iframe (session_id is the credential) |
POST | /v1/widget-sessions/{session_id}/charge | Submit card data — called internally by the iframe, not by merchants |
Auth
| Method | Endpoint | Description |
|---|
GET | /v1/auth/check | Verify API key validity |
Apps
| Method | Endpoint | Description |
|---|
GET | /v1/projects | List organization apps |
Health
| Method | Endpoint | Description |
|---|
GET | /health | Service health check |
Rate Limits
All endpoints are rate-limited per IP address.
Errors
The API uses standard HTTP status codes. Error responses include a detail field with a human-readable message.
Interactive Playground
Use the API playground on each endpoint page to make test requests directly from the documentation. Enter your test API key to get started.