Show for
Surfaces → REST
REST API (public, v1)
REST is APT Commerce's stable public contract. External developers, SDKs, merchants, and partners consume it. Every resource is versioned at /v1/* and described by an OpenAPI 3.1 document.
Conventions at a glance
- IDs are prefixed. e.g.
pi_,txn_,ref_,cus_. - Idempotency is required for money-moving writes via
Idempotency-Key. - Pagination is cursor-based.
data,has_more,next_cursor. - Errors use the canonical envelope. See Reference → Errors.
- Auth uses bearer keys with scopes. See Learn → Authentication.
Where to go next
Related
- · Transport security — TLS policy and certificate rotation
- · Pagination
- · Rate limiting