0. How to read this documentation
Learn which documentation section to use before and during implementation.
Use this page to choose the right documentation section before you start implementing.
Documentation sections
Every published section, and when to reach for it.
| Section | Use it when | Start at |
|---|---|---|
| Functional | You need product context before making a technical decision; how refunds work, what each engine does, what statuses mean. | Refunds API |
| Schema | You are about to implement and need the data model: which objects exist, what they contain, how they relate. | What is a document? |
| GraphQL | You are new to GraphQL, or need our specific conventions; authentication, request parameters, testing in other environments. | REST vs GraphQL |
| FAQ | You hit a specific question mid-build: auth, errors, rate limits, testing, performance, security, reporting, support. | 1. Getting started |
| Design system | You or your agents will use the OnePoint web UI, and you need to configure roles and manage users. | Role guide |
| Compensations GraphQL API | You are integrating the compensations GraphQL API (/compensations): create and read compensation requests. | Introduction |
Reading order
If you are new, read in this order; each step assumes the one before it.
- Functional: product concepts and expected behavior, before any technical detail.
- Schema: the objects and relationships you will be working with.
- GraphQL: our conventions for querying, authenticating, and choosing an environment.
- FAQ: kept for the specific question you hit while building.
If you only read one thing
Going straight to implementation? Start with 1. Getting started for the endpoint and your first authenticated call, then Refund lifecycle & statuses for the call order that actually produces a refund.
Stuck? Support has the escalation path.
Updated 26 days ago
Did this page help you?