API Reference
The complete, generated reference for every ShadhinPay HTTP endpoint.
The API reference documents every endpoint — paths, parameters, request and response schemas, and status codes — generated directly from the backend's OpenAPI specification so it always matches the live API.
While you're here, the hand-written guides cover the same surface with worked examples and integration patterns:
- Authentication and API conventions
- Payments, Refunds, and Invoices
- Webhooks and Errors
Generating the reference
The reference pages are produced from docs/spec-api/*.yaml by
scripts/gen-openapi-docs.mjs (pnpm gen:openapi). They render with the APIPage
component wired up in src/mdx-components.tsx. Run the generator once the backend
has emitted its OpenAPI specs to populate this section.