Endpoints at a glance

MethodPathPurpose
POST/ledger/v1/transactionsRecord a batch of balanced transaction blocks
POST/ledger/v1/transactions/{transactionId}/correctionsRecord a compensating reversal
POST/ledger/v1/eventsSubmit a business event
GET/ledger/v1/eventsInquire submitted events
POST/ledger/v1/events/batchBulk import events
GET/POST/DELETE/ledger/v1/failed-events…Dead-letter queue

Live API document: http://localhost:8080/q/openapi · Swagger UI: http://localhost:8080/q/swagger-ui · Health: /q/health · Metrics: /q/metrics.

Common headers

HeaderRequiredNotes
X-Tenant-IDyesOrganization the write applies to
X-Idempotency-Keyfor transactions & correctionsClient-chosen key; replays return 409
X-Correlation-IDnoOptional UUID linking related batches
Authorizationin productionBearer token with {orgId}:write:ledger (event inquiry needs only {orgId}:read:ledger)

Maximum request body size is 10 MB.