API Reference
Base URL https://app.satsrail.com. Merchant endpoints, under
/api/v1/m/, take a secret key (sk_live_…, or
sk_test_… in test mode) as
Authorization: Bearer. Public endpoints, under
/api/v1/pub/, take a publishable key
(pk_live_…) where they need one.
This page draws the full reference with JavaScript. The same reference as text, with every parameter, request field and example response: Markdown. The document it is drawn from: OpenAPI 3.0 (JSON). Every page of these docs in one file: llms-full.txt.
Merchant API
| Method | Path | Summary |
|---|---|---|
POST | /api/v1/m/access/verify | verify |
GET | /api/v1/m/api_tokens/{id}/usage | Get API token usage |
GET | /api/v1/m/catalog | show |
POST | /api/v1/m/invoices/generate | generate |
GET | /api/v1/m/invoices/{id} | show |
GET | /api/v1/m/invoices/{id}/qr | qr |
GET | /api/v1/m/invoices/{id}/status | status |
GET | /api/v1/m/media_keys | index |
POST | /api/v1/m/media_keys | create |
GET | /api/v1/m/media_keys/{id} | show |
PATCH | /api/v1/m/media_keys/{id} | update |
DELETE | /api/v1/m/media_keys/{id} | destroy |
POST | /api/v1/m/media_keys/{id}/clear_old_key | clear_old_key |
GET | /api/v1/m/media_keys/{id}/key | key |
POST | /api/v1/m/media_keys/{id}/products | link_products |
DELETE | /api/v1/m/media_keys/{id}/products/{product_id} | unlink_product |
POST | /api/v1/m/media_keys/{id}/rotate | rotate |
GET | /api/v1/m/merchant | show |
GET | /api/v1/m/orders | index |
POST | /api/v1/m/orders | create |
GET | /api/v1/m/orders/{id} | show |
PATCH | /api/v1/m/orders/{id} | update |
DELETE | /api/v1/m/orders/{id} | destroy |
POST | /api/v1/m/payment_requests | create |
GET | /api/v1/m/payment_requests/{id} | show |
GET | /api/v1/m/payment_requests/{id}/status | status |
GET | /api/v1/m/payments | index |
GET | /api/v1/m/payments/{id} | show |
GET | /api/v1/m/products | List products |
POST | /api/v1/m/products | Create a product |
GET | /api/v1/m/products/{id} | Get a product |
PATCH | /api/v1/m/products/{id} | Update a product |
DELETE | /api/v1/m/products/{id} | Archive a product |
POST | /api/v1/m/products/{product_id}/media_keys | link_to_product |
DELETE | /api/v1/m/products/{product_id}/media_keys/{id} | unlink_from_product |
POST | /api/v1/m/sessions | create |
POST | /api/v1/m/sessions/activate | activate |
GET | /api/v1/m/wallets | index |
GET | /api/v1/m/wallets/{id} | show |
GET | /api/v1/m/webhooks | index |
POST | /api/v1/m/webhooks | create |
GET | /api/v1/m/webhooks/{id} | show |
PATCH | /api/v1/m/webhooks/{id} | update |
DELETE | /api/v1/m/webhooks/{id} | destroy |
Public API
| Method | Path | Summary |
|---|---|---|
POST | /api/v1/pub/access/verify | verify |
GET | /api/v1/pub/categories | index |
GET | /api/v1/pub/channels | index |
POST | /api/v1/pub/checkout_sessions | create |
GET | /api/v1/pub/creators | index |
GET | /api/v1/pub/exchanges | index |
GET | /api/v1/pub/subscription_plans | index |