Skip to main content

Documentation Index

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

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

The current public API surface is hosted from the dashboard origin: 
https://dash.getopenrails.com
The hosted checkout surface is separate: 
https://pay.getopenrails.com

​
Endpoints

EndpointPurpose
GET /api/agent/capabilitiesDiscover agent-safe entrypoints, actions, schemas, routes, CLI hints, and webhook events.
GET /api/agent/routesList available payment routes, economics, provider health, and KYC policy.
GET /api/agent/schema/{operation}Fetch JSON Schema for an operation before constructing a request.
POST /api/agent/actions/{action}Run checkout, fee estimate, and webhook example actions.

​
Action names

  • checkout.preview
  • checkout.create
  • fees.estimate
  • webhook.example
  • webhook.verify_sample

​
Error shape

Errors are parseable and include an action, stable code, human-readable message, and optional field-level issues. 
{
  "ok": false,
  "action": "checkout.create",
  "error": {
    "code": "invalid_input",
    "message": "Input did not match the action schema.",
    "suggestion": "Fetch /api/agent/schema/checkout.create and retry with the documented shape.",
    "issues": [
      {
        "path": "customer",
        "code": "invalid_format",
        "message": "Invalid email address"
      }
    ]
  }
}