Guides
Task-shaped walkthroughs — quickstart, each payment method, webhooks, idempotency, test mode and going live.
Guides are the task-shaped half of this site: the reference tells you what a field is, a guide tells you what to do. They are written and tested by ST-DOC-002, and none have landed yet — this page lists them as they arrive.
Meanwhile the Introduction covers environments and modes, authentication, headers, money, idempotency, errors, pagination, rate limits and versioning, which is most of what a first integration needs, and every operation page has a Try it panel that makes a real test-mode call.
Planned
| Guide | What it covers |
|---|---|
| Quickstart | Create a payment, show the QR, handle the webhook. |
| Payment methods | One section per method: what the payer sees, what next_action carries, what can fail. |
| Hosted checkout and links | When not to build your own payment page. |
| Refunds and approvals | Requesting, the two-person rule, partial refunds, the refund window. |
| Webhooks | Endpoint setup, signature verification, redelivery, ordering. |
| Idempotency and retries | What to retry, with which key, and how to back off. |
| Test mode | Test keys, the simulation API, magic values, the test inbox. |
| Going live | The checklist, and what changes when the key prefix does. |
| Rate limits | The limits, the headers, and designing not to need them. |
Writing a guide
Everything a guide needs is in this repository's portals/docs/README.md: a file in src/content/docs/guides/, front matter with title, description, sidebar.order and apiVersion, code samples imported from snippets/ with <Code file="…" /> so that the guide and the snippet runner test the same bytes, and every error code written as a link to its catalogue page — which the build checks, and fails on an unknown code.
No guides have been published yet.