# Endpoint reference

Every tenant endpoint, generated from the OpenAPI spec. Each page has a request builder you can run against your own deployment.

URL: https://docs.shiwake.app/docs/reference



{/* This file was generated by scripts/generate-openapi-docs.mjs. Do not edit it directly. */}

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](/docs/api).

Accounts [#accounts]

<Cards>
  <Card href="/docs/reference/accounts/get-ledger-accounts" title="/ledger/accounts" description="GET" />

  <Card href="/docs/reference/accounts/post-ledger-accounts" title="/ledger/accounts" description="POST" />

  <Card href="/docs/reference/accounts/get-ledger-accounts-accountid" title="/ledger/accounts/{accountId}" description="GET" />

  <Card href="/docs/reference/accounts/get-ledger-accounts-by-code-code" title="/ledger/accounts/by-code/{code}" description="GET · Look up an account by its unique code (e.g. WARD-{studentId})." />

  <Card href="/docs/reference/accounts/post-ledger-accounts-accountid-rename-code" title="/ledger/accounts/{accountId}/rename-code" description="POST · Repair an account's code within this tenant." />

  <Card href="/docs/reference/accounts/post-ledger-accounts-accountid-deactivate" title="/ledger/accounts/{accountId}/deactivate" description="POST" />

  <Card href="/docs/reference/accounts/get-ledger-accounts-accountid-balance" title="/ledger/accounts/{accountId}/balance" description="GET" />

  <Card href="/docs/reference/accounts/get-ledger-accounts-accountid-transactions" title="/ledger/accounts/{accountId}/transactions" description="GET · Paginated transaction log using cursor (keyset) pagination." />
</Cards>

Audit log [#audit-log]

<Cards>
  <Card href="/docs/reference/audit-log/get-banking-audit" title="/banking/audit" description="GET · List banking audit events with optional filters and cursor-based pagination." />

  <Card href="/docs/reference/audit-log/get-banking-audit-id" title="/banking/audit/{id}" description="GET · Get a single banking audit event by id." />
</Cards>

Banking holds [#banking-holds]

<Cards>
  <Card href="/docs/reference/banking-holds/get-banking-holds" title="/banking/holds" description="GET" />
</Cards>

Transactions [#transactions]

<Cards>
  <Card href="/docs/reference/transactions/post-banking-wallets-walletid-deposit" title="/banking/wallets/{walletId}/deposit" description="POST" />

  <Card href="/docs/reference/transactions/post-banking-wallets-walletid-withdraw" title="/banking/wallets/{walletId}/withdraw" description="POST" />

  <Card href="/docs/reference/transactions/post-banking-transactions-id-confirm" title="/banking/transactions/{id}/confirm" description="POST" />

  <Card href="/docs/reference/transactions/post-banking-transactions-id-cancel" title="/banking/transactions/{id}/cancel" description="POST" />

  <Card href="/docs/reference/transactions/get-banking-transactions" title="/banking/transactions" description="GET" />

  <Card href="/docs/reference/transactions/get-banking-transactions-id" title="/banking/transactions/{id}" description="GET" />
</Cards>

Fee schedules [#fee-schedules]

<Cards>
  <Card href="/docs/reference/fee-schedules/get-banking-fee-schedules" title="/banking/fee-schedules" description="GET" />

  <Card href="/docs/reference/fee-schedules/post-banking-fee-schedules" title="/banking/fee-schedules" description="POST" />

  <Card href="/docs/reference/fee-schedules/get-banking-fee-schedules-id" title="/banking/fee-schedules/{id}" description="GET" />

  <Card href="/docs/reference/fee-schedules/patch-banking-fee-schedules-id" title="/banking/fee-schedules/{id}" description="PATCH" />

  <Card href="/docs/reference/fee-schedules/delete-banking-fee-schedules-id" title="/banking/fee-schedules/{id}" description="DELETE" />

  <Card href="/docs/reference/fee-schedules/post-banking-fee-schedules-id-simulate" title="/banking/fee-schedules/{id}/simulate" description="POST" />
</Cards>

Holds [#holds]

<Cards>
  <Card href="/docs/reference/holds/post-ledger-holds" title="/ledger/holds" description="POST" />

  <Card href="/docs/reference/holds/post-ledger-holds-holdid-capture" title="/ledger/holds/{holdId}/capture" description="POST" />

  <Card href="/docs/reference/holds/post-ledger-holds-holdid-release" title="/ledger/holds/{holdId}/release" description="POST" />

  <Card href="/docs/reference/holds/get-ledger-accounts-accountid-holds" title="/ledger/accounts/{accountId}/holds" description="GET" />
</Cards>

Journal entries [#journal-entries]

<Cards>
  <Card href="/docs/reference/journal-entries/get-ledger-journal-entries" title="/ledger/journal-entries" description="GET" />

  <Card href="/docs/reference/journal-entries/post-ledger-journal-entries" title="/ledger/journal-entries" description="POST" />

  <Card href="/docs/reference/journal-entries/get-ledger-journal-entries-entryid" title="/ledger/journal-entries/{entryId}" description="GET" />

  <Card href="/docs/reference/journal-entries/post-ledger-journal-entries-entryid-reverse" title="/ledger/journal-entries/{entryId}/reverse" description="POST" />
</Cards>

Reconciliation [#reconciliation]

<Cards>
  <Card href="/docs/reference/reconciliation/get-ledger-reconciliation-trial-balance" title="/ledger/reconciliation/trial-balance" description="GET · Returns a trial balance: total debits and credits per account from posted journal entry lines." />

  <Card href="/docs/reference/reconciliation/get-ledger-reconciliation-verify-balances" title="/ledger/reconciliation/verify-balances" description="GET · Compares stored account_balances against balances computed fresh from entry_lines." />
</Cards>

Reports [#reports]

<Cards>
  <Card href="/docs/reference/reports/get-banking-wallets-walletid-statement" title="/banking/wallets/{walletId}/statement" description="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…" />

  <Card href="/docs/reference/reports/get-banking-reports-summary" title="/banking/reports/summary" description="GET · Aggregated report for the current tenant: deposit/withdrawal totals, transfer volume, fees collected, channel breakdown, and wallet counts by product." />

  <Card href="/docs/reference/reports/get-banking-reports-currencies" title="/banking/reports/currencies" description="GET · The distinct wallet currencies this tenant uses, for currency pickers." />

  <Card href="/docs/reference/reports/get-banking-reports-daily-flow" title="/banking/reports/daily-flow" description="GET · Daily completed money-in / money-out / fees over a date range, for one currency: a trend series for the overview chart." />

  <Card href="/docs/reference/reports/get-banking-reports-ledger-snapshot" title="/banking/reports/ledger-snapshot" description="GET · One-shot balance snapshot for the current tenant: system-account balances (float / fee-revenue / fee-expense), total MERCHANT payable, unresolved suspense, a…" />

  <Card href="/docs/reference/reports/get-platform-reports-summary" title="/platform/reports/summary" description="GET · Cross-tenant summary for platform administrators." />
</Cards>

Suspense [#suspense]

<Cards>
  <Card href="/docs/reference/suspense/get-banking-suspense" title="/banking/suspense" description="GET" />

  <Card href="/docs/reference/suspense/post-banking-suspense" title="/banking/suspense" description="POST" />

  <Card href="/docs/reference/suspense/get-banking-suspense-id" title="/banking/suspense/{id}" description="GET" />

  <Card href="/docs/reference/suspense/post-banking-suspense-id-match" title="/banking/suspense/{id}/match" description="POST" />

  <Card href="/docs/reference/suspense/post-banking-suspense-id-refund" title="/banking/suspense/{id}/refund" description="POST" />

  <Card href="/docs/reference/suspense/get-banking-reconciliation" title="/banking/reconciliation" description="GET" />
</Cards>

Tenants [#tenants]

<Cards>
  <Card href="/docs/reference/tenants/get-platform-tenants" title="/platform/tenants" description="GET · List all tenants." />

  <Card href="/docs/reference/tenants/post-platform-tenants" title="/platform/tenants" description="POST · Create a new tenant." />

  <Card href="/docs/reference/tenants/post-platform-tenants-id-bootstrap-banking" title="/platform/tenants/{id}/bootstrap-banking" description="POST · Bootstrap banking system accounts (PLATFORM-FLOAT, FEE-REVENUE) for an existing tenant in the given currency." />

  <Card href="/docs/reference/tenants/get-platform-tenants-id" title="/platform/tenants/{id}" description="GET · Get a single tenant by ID." />

  <Card href="/docs/reference/tenants/patch-platform-tenants-id" title="/platform/tenants/{id}" description="PATCH · Update tenant properties (name only for now)." />

  <Card href="/docs/reference/tenants/post-platform-tenants-id-disable" title="/platform/tenants/{id}/disable" description="POST · Disable a tenant (soft delete)." />

  <Card href="/docs/reference/tenants/post-platform-tenants-id-enable" title="/platform/tenants/{id}/enable" description="POST · Re-enable a previously disabled tenant." />

  <Card href="/docs/reference/tenants/post-platform-tenants-id-rotate-api-key" title="/platform/tenants/{id}/rotate-api-key" description="POST · Generate (or rotate) an API key for a tenant." />
</Cards>

Tenant settings [#tenant-settings]

<Cards>
  <Card href="/docs/reference/tenant-settings/get-tenant-settings-api-key" title="/tenant/settings/api-key" description="GET · Get the API-key status for the current tenant." />

  <Card href="/docs/reference/tenant-settings/post-tenant-settings-rotate-api-key" title="/tenant/settings/rotate-api-key" description="POST · Generate (or rotate) the API key for the current tenant." />
</Cards>

Limits [#limits]

<Cards>
  <Card href="/docs/reference/limits/get-banking-limits" title="/banking/limits" description="GET" />

  <Card href="/docs/reference/limits/post-banking-limits" title="/banking/limits" description="POST" />

  <Card href="/docs/reference/limits/get-banking-limits-id" title="/banking/limits/{id}" description="GET" />

  <Card href="/docs/reference/limits/patch-banking-limits-id" title="/banking/limits/{id}" description="PATCH" />

  <Card href="/docs/reference/limits/delete-banking-limits-id" title="/banking/limits/{id}" description="DELETE" />
</Cards>

Transfers [#transfers]

<Cards>
  <Card href="/docs/reference/transfers/get-banking-transfers" title="/banking/transfers" description="GET" />

  <Card href="/docs/reference/transfers/post-banking-transfers" title="/banking/transfers" description="POST" />

  <Card href="/docs/reference/transfers/get-banking-transfers-id" title="/banking/transfers/{id}" description="GET" />
</Cards>

Wallet products [#wallet-products]

<Cards>
  <Card href="/docs/reference/wallet-products/get-banking-wallet-products" title="/banking/wallet-products" description="GET" />

  <Card href="/docs/reference/wallet-products/post-banking-wallet-products" title="/banking/wallet-products" description="POST" />

  <Card href="/docs/reference/wallet-products/get-banking-wallet-products-id" title="/banking/wallet-products/{id}" description="GET" />

  <Card href="/docs/reference/wallet-products/patch-banking-wallet-products-id" title="/banking/wallet-products/{id}" description="PATCH" />

  <Card href="/docs/reference/wallet-products/get-banking-wallet-products-by-code-code" title="/banking/wallet-products/by-code/{code}" description="GET" />
</Cards>

Wallets [#wallets]

<Cards>
  <Card href="/docs/reference/wallets/get-banking-wallets" title="/banking/wallets" description="GET" />

  <Card href="/docs/reference/wallets/post-banking-wallets" title="/banking/wallets" description="POST" />

  <Card href="/docs/reference/wallets/get-banking-wallets-id" title="/banking/wallets/{id}" description="GET" />

  <Card href="/docs/reference/wallets/get-banking-wallets-by-owner-ownerid" title="/banking/wallets/by-owner/{ownerId}" description="GET" />

  <Card href="/docs/reference/wallets/post-banking-wallets-id-freeze" title="/banking/wallets/{id}/freeze" description="POST" />

  <Card href="/docs/reference/wallets/post-banking-wallets-id-unfreeze" title="/banking/wallets/{id}/unfreeze" description="POST" />

  <Card href="/docs/reference/wallets/post-banking-wallets-id-close" title="/banking/wallets/{id}/close" description="POST" />

  <Card href="/docs/reference/wallets/post-banking-wallets-id-upgrade-tier" title="/banking/wallets/{id}/upgrade-tier" description="POST" />

  <Card href="/docs/reference/wallets/get-banking-wallets-id-limits-usage" title="/banking/wallets/{id}/limits/usage" description="GET" />
</Cards>
