Introduction

Overview

Pinrail Docs is the public documentation surface for external developers, sponsor-bank partners, and terminal operators.

Use this site for:

• understanding the current public API and integration model
• learning how terminal-management workflows are exposed today
• reviewing webhook and RSS-feed planning guidance
• navigating operator-facing TMS concepts and terminology

Current Product Surface

Today, the public docs site focuses on the parts of Pinrail that are already useful to customers and integration partners:

• authenticated tenant-facing API access
• terminal-management workflows and visibility
• webhook planning and event-family guidance
• ATM programming guidance by vendor
• TMS usage and operator concepts

Source Of Truth

Public contracts are owned by the service repos first and then published here once they are stable for external consumers.

• pinrail-platform owns the operator and tenant API surface
• pinrail-shared-contracts is the long-term home for reusable public schemas
• pinrail-sdk-* repos will consume the stable contracts published from the platform
• pinrail-customer-examples will hold runnable examples once the first public flows are locked

Deployment

This site is built from Markdown and MDX stored in GitHub and deployed to Cloudflare Workers using OpenNext.