API Reference

Public endpoints

Curated, tenant-safe endpoints with OAuth2 scopes. Use Idempotency-Key for all writes.

Interactive Console

Explore the API with Scalar

Live reference powered by the OpenAPI spec.

Spec: /openapi.yaml
Loading API console...
Ledger

Accounts, balances, transactions

Scope: read:ledger
GET/accountsList accounts
GET/accounts/{id}Account detail
GET/accounts/{id}/transactionsAccount transactions
GET/accounts/{id}/balancesBalance snapshots
GET/accounts/{id}/coverageStatement coverage
GET/accounts/{id}/intradayIntraday points
GET/transactionsList transactions
GET/transactions/{id}Transaction detail
Payments

Batches, instructions, status

Scope: read:payments / write:payments
GET/payments/batchesList batches
POST/payments/batchesCreate batch (idempotent)
GET/payments/batches/{id}Batch detail
POST/payments/batches/{id}/submitSubmit batch (idempotent)
GET/payments/instructions/{id}Instruction detail
GET/payments/status-eventsStatus timeline
Approvals

Approval workflow

Scope: approve:payments
GET/approvals/pendingPending approvals
POST/approvals/{id}/approveApprove (idempotent)
POST/approvals/{id}/rejectReject (idempotent)
Reconciliation

Match confirmation

Scope: read:reconciliation / write:reconciliation
GET/reconciliation/matchesList matches
POST/reconciliation/matches/{id}/confirmConfirm match (idempotent)
POST/reconciliation/matches/{id}/rejectReject match (idempotent)
Reporting

Cashflow and positions

Scope: read:reporting / read:forecast
GET/reporting/cashflow/dailyDaily cashflow
GET/reporting/positions/dailyDaily positions
GET/reporting/forecastForecast
Organizations

Companies and koncerner

Scope: read:ledger
GET/companiesList companies
GET/companies/{id}Company detail
GET/koncernerList koncerner
GET/koncerner/{id}Koncern detail
GET/koncerner/{id}/breakdownKoncern breakdown
Webhooks

Endpoints and event subscriptions

Scope: admin:public_api
GET/webhooksList webhook endpoints
POST/webhooksCreate endpoint (idempotent)
GET/webhooks/{id}Endpoint detail
PATCH/webhooks/{id}Update endpoint (idempotent)
DELETE/webhooks/{id}Delete endpoint (idempotent)