Pinrail Docs
API Reference

Terminal API Areas

Public overview of the current terminal-management API resource families.

Resources

The present operator API shape includes these resource families:

  • terminals and terminal summaries
  • connectors, connector detail, and connector status runs
  • terminal groups and fleet-level policy fanout
  • provisioning exports and provisioning job actions
  • settlement and ACH workflow endpoints for operator back-office flows

Terminal Management

Terminal resources cover inventory, detail, group membership, connector assignment, and routing-policy-aware provisioning.

Typical usage:

  1. fetch the terminal roster
  2. inspect a terminal or group
  3. review connector ownership and policy inputs
  4. generate or apply provisioning output

Connector Operations

Connector resources support:

  • connector registration and lookup
  • connector filtering and roster summaries
  • connector status inspection
  • sync-run history and operator review

Contract Status

These workflows are implemented today in pinrail-platform, but the fully generated OpenAPI reference is still a follow-up deliverable. Until then, this page should be read as a public workflow map rather than a complete schema reference.

On this page