API Reference

The Payment Reconciler API is organized around REST. It has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

All endpoints (except health) require authentication. Include the required headers in every request. See Authentication for JWT and API key setup.

Authentication

All endpoints (except health and POST /auth/token) require authentication. Include:

• Authorization: Bearer <jwt> or Authorization: Bearer <api_key> (opaque), or X-Api-Key: <api_key> (full pr_<public>.<secret> string). See Required Headers.
• X-Tenant-Id: <tenant-id>
• X-Environment: production (or development, staging, test)

Interactive docs support both Bearer and X-Api-Key in Swagger.

Resources

• Tenants — POST/GET /tenants, PATCH /tenants/:id/settings
• Expected transactions — POST/GET /expected-transactions
• Incoming transactions — POST/GET /incoming-transactions, POST /incoming-transactions/upload
• Matches — POST /matches/match, GET /matches, POST /matches/:id/accept
• Data sources — GET/POST /data-sources
• Webhooks — GET/POST /webhooks
• Jobs — GET/POST /jobs

Swagger

Interactive docs: http://localhost:8000/api/docsCopy