API Reference
API Overview
Structure for generated and curated Pinrail API reference content.
API Surface
The current public documentation scope centers on the application-tier resources owned by pinrail-platform.
Current Resource Areas
- terminals and terminal summaries
- connector inventory, detail, and status runs
- terminal groups and group-level policy fanout
- provisioning exports and provisioning job actions
- settlement and ACH batch workflows
Publication Strategy
This site is designed to hold:
- generated OpenAPI reference for stable public endpoints
- hand-written workflow guides where generated reference is not enough
- customer-safe examples for auth, pagination, errors, and idempotency
Upstream Source
The public API reference should be generated from stable contracts owned by pinrail-platform, then committed here as customer-facing documentation content.