API reference¶
Each backend HTTP surface ships an OpenAPI / Swagger document. Production-style
URLs below resolve against the dev2.mycashless.com ingress; replace the host
with localhost:<port> to hit a locally-running service.
Auth — cashless-auth¶
FastAPI service. Schema is auto-generated from the route signatures.
| Resource | URL |
|---|---|
| Swagger UI | auth.dev2.mycashless.com/docs |
| ReDoc | auth.dev2.mycashless.com/redoc |
| OpenAPI JSON | auth.dev2.mycashless.com/openapi.json |
Identity flows: password, phone OTP, Firebase token exchange, device, API key, and MFA. Issues short-lived access tokens + opaque refresh tokens backed by Redis.
Admin API — cashless-backend¶
FastAPI service mounted at /v2 on api.dev2.mycashless.com (the cm_v2
rewrite). Schema is auto-generated from the route signatures.
| Resource | URL |
|---|---|
| Swagger UI | api.dev2.mycashless.com/v2/docs |
| ReDoc | api.dev2.mycashless.com/v2/redoc |
| OpenAPI JSON | api.dev2.mycashless.com/v2/openapi.json |
Background-job endpoints (notifications, NFC, sales aggregation, backups) are
called by cashless-worker and the operator UIs; consult the source under
backend/cashless-backend
for surface details.
Personal Account API — personalaccount-api¶
FastAPI service mounted at /v4 on pa-api.dev2.mycashless.com (the pa_v4
rewrite). Schema is auto-generated from the route signatures.
| Resource | URL |
|---|---|
| Swagger UI | pa-api.dev2.mycashless.com/v4/docs |
| ReDoc | pa-api.dev2.mycashless.com/v4/redoc |
| OpenAPI JSON | pa-api.dev2.mycashless.com/v4/openapi.json |
Cardholder-facing surface: balance, top-up, refund, reservations, cart, push preferences. Stripe + Mercado Pago + Adyen + direct PayPal supported.
Authentication¶
All non-public endpoints require a Bearer token obtained from cashless-auth.
Tokens are scoped to a role: admin, operator, network_manager,
consumer, device, or event_client. See
Auth model for the full claim shape, lifetimes, and the
canonical validation pattern.
Versioning¶
| Service | Current surface |
|---|---|
cashless-backend |
v2 (/v2) — cm_v2 |
personalaccount-api |
v4 (/v4) — pa_v4 |
cashless-auth |
v1 |