Endpoint reference
Every tenant endpoint, generated from the OpenAPI spec. Each page has a request builder you can run against your own deployment.
Tenant endpoints authenticate with an X-Api-Key header and mutating calls take an Idempotency-Key. Platform tenant management uses a platform-admin bearer token. For the concepts behind these endpoints, start with the REST API guide.
Accounts
/ledger/accounts
GET
/ledger/accounts
POST
/ledger/accounts/{accountId}
GET
/ledger/accounts/by-code/{code}
GET · Look up an account by its unique code (e.g. WARD-{studentId}).
/ledger/accounts/{accountId}/rename-code
POST · Repair an account's code within this tenant.
/ledger/accounts/{accountId}/deactivate
POST
/ledger/accounts/{accountId}/balance
GET
/ledger/accounts/{accountId}/transactions
GET · Paginated transaction log using cursor (keyset) pagination.
Audit log
/banking/audit
GET · List banking audit events with optional filters and cursor-based pagination.
/banking/audit/{id}
GET · Get a single banking audit event by id.
Banking holds
Transactions
/banking/wallets/{walletId}/deposit
POST
/banking/wallets/{walletId}/withdraw
POST
/banking/transactions/{id}/confirm
POST
/banking/transactions/{id}/cancel
POST
/banking/transactions
GET
/banking/transactions/{id}
GET
Fee schedules
/banking/fee-schedules
GET
/banking/fee-schedules
POST
/banking/fee-schedules/{id}
GET
/banking/fee-schedules/{id}
PATCH
/banking/fee-schedules/{id}
DELETE
/banking/fee-schedules/{id}/simulate
POST
Holds
/ledger/holds
POST
/ledger/holds/{holdId}/capture
POST
/ledger/holds/{holdId}/release
POST
/ledger/accounts/{accountId}/holds
GET
Journal entries
/ledger/journal-entries
GET
/ledger/journal-entries
POST
/ledger/journal-entries/{entryId}
GET
/ledger/journal-entries/{entryId}/reverse
POST
Reconciliation
/ledger/reconciliation/trial-balance
GET · Returns a trial balance: total debits and credits per account from posted journal entry lines.
/ledger/reconciliation/verify-balances
GET · Compares stored account_balances against balances computed fresh from entry_lines.
Reports
/banking/wallets/{walletId}/statement
GET · Returns a wallet statement for the given date range, including opening/closing balances, line-by-line entries with running balance, and deposit/withdrawal/tr…
/banking/reports/summary
GET · Aggregated report for the current tenant: deposit/withdrawal totals, transfer volume, fees collected, channel breakdown, and wallet counts by product.
/banking/reports/currencies
GET · The distinct wallet currencies this tenant uses, for currency pickers.
/banking/reports/daily-flow
GET · Daily completed money-in / money-out / fees over a date range, for one currency: a trend series for the overview chart.
/banking/reports/ledger-snapshot
GET · One-shot balance snapshot for the current tenant: system-account balances (float / fee-revenue / fee-expense), total MERCHANT payable, unresolved suspense, a…
/platform/reports/summary
GET · Cross-tenant summary for platform administrators.
Suspense
/banking/suspense
GET
/banking/suspense
POST
/banking/suspense/{id}
GET
/banking/suspense/{id}/match
POST
/banking/suspense/{id}/refund
POST
/banking/reconciliation
GET
Tenants
/platform/tenants
GET · List all tenants.
/platform/tenants
POST · Create a new tenant.
/platform/tenants/{id}/bootstrap-banking
POST · Bootstrap banking system accounts (PLATFORM-FLOAT, FEE-REVENUE) for an existing tenant in the given currency.
/platform/tenants/{id}
GET · Get a single tenant by ID.
/platform/tenants/{id}
PATCH · Update tenant properties (name only for now).
/platform/tenants/{id}/disable
POST · Disable a tenant (soft delete).
/platform/tenants/{id}/enable
POST · Re-enable a previously disabled tenant.
/platform/tenants/{id}/rotate-api-key
POST · Generate (or rotate) an API key for a tenant.
Tenant settings
/tenant/settings/api-key
GET · Get the API-key status for the current tenant.
/tenant/settings/rotate-api-key
POST · Generate (or rotate) the API key for the current tenant.
Limits
/banking/limits
GET
/banking/limits
POST
/banking/limits/{id}
GET
/banking/limits/{id}
PATCH
/banking/limits/{id}
DELETE
Transfers
Wallet products
/banking/wallet-products
GET
/banking/wallet-products
POST
/banking/wallet-products/{id}
GET
/banking/wallet-products/{id}
PATCH
/banking/wallet-products/by-code/{code}
GET
Wallets
Last updated on