Changelog
API changes, versioned and dated.
Lumeo uses date-based API versioning. The current version is 2026-07. Breaking changes are introduced only with a new version and announced here at least 30 days in advance.
2026-07-01: 2026-07
Initial public release of the Lumeo developer API.
New endpoints
POST /payments/initiate: record a payout intentPOST /payments/confirm: trigger compliance check and settlementGET /payments/payouts/:id: fetch payment statusGET /compliance/fira/:firaId: fetch an auto-generated FIRAGET /compliance/gst/summary: year-to-date GST positionGET /compliance/itr4/prefill: ITR-4 (44ADA) prefill dataGET /ledger/accounts/:id/balance: account balance (paise, integer)GET /ledger/accounts/:id/entries: paginated journal entriesGET /ledger/reconciliation/:paymentId: reconciliation statusPOST /ledger/reconciliation/:paymentId/resolve: manual reconciliation resolutionGET /tax/liability: estimated income tax liabilityGET /tax/sequestration: sequestration reserve balancePOST /tax/sequestration/policy: configure sequestration rateGET /tax/exports/gst3b: GST-3B-ready JSON exportGET /tax/exports/itr4: ITR-4-ready JSON exportPOST /webhooks: register a webhook endpointGET /webhooks/:id/deliveries: delivery log with retry history
Webhook events (initial set)
payout.initiated, payout.confirmed, payout.settled, payout.failed, payout.manual_review, fira.generated, reconciliation.completed, reconciliation.pending, tax.updated, yield.allocated
SDKs
@lumeo/sdkv1.0.0: TypeScript / Node.js
Upcoming
The following are planned for a future release. They are not stable and not yet available in sandbox:
GET /payments/payouts: paginated list with date/status filteringPOST /payments/payouts/:id/cancel: cancel a payment before settlement- Batch payout endpoint: up to 50 recipients in a single call
- Python and Go SDKs
- Yield allocation API: configure and query yield instrument allocation