Reference
API reference
A small, focused merchant API surface — create and track payments, and register a webhook endpoint to hear about state changes as they happen. Full request/response schemas, including every field and validation rule, are in the interactive docs the backend serves directly — that's the canonical, always-in-sync reference, not this table.
| Method | Endpoint | What it does |
|---|---|---|
| POST | /v1/payments | Create a payment intent |
| GET | /v1/payments/{id} | Retrieve a payment |
| GET | /v1/payments | List payments (paginated, filterable by state) |
| POST | /v1/webhooks | Register a webhook endpoint |
| GET | /v1/webhooks | List your webhook endpoints |
| GET | /v1/webhooks/{id} | Retrieve a webhook endpoint |
| PATCH | /v1/webhooks/{id} | Update a webhook endpoint |
| DELETE | /v1/webhooks/{id} | Deactivate a webhook endpoint |
| GET | /v1/ping | Unauthenticated liveness check |
POST /v1/payments/{id}/capture, /void, and /refund exist as service methods but are not yet routed to any endpoint — not part of this API surface today. POST /v1/payments with the default capture_mode="automatic" already captures automatically.
Interactive reference
Full endpoint-by-endpoint schemas, try-it-out request builder, and the raw OpenAPI 3.1 spec are served directly by the backend — this is the primary reference for the development team integrating request/response shapes.