ShiwakeDocs

Statements & Reports

Wallet statements, tenant summaries, and platform-wide reports: all returned as JSON.

Three reporting endpoints return structured JSON data for different audiences: wallet holders, tenant operators, and platform administrators.

Wallet statement

GET/api/v1/banking/wallets/{walletId}/statement?from=2026-03-01&to=2026-03-31

Returns a detailed statement for a single wallet over a date range, including opening/closing balances, line-by-line entries with running balance, and deposit/withdrawal/transfer/fee summaries.

Query parameters

Prop

Type

How the opening balance is computed

The opening balance is the sum of all double-entry ledger lines on the wallet's account before the from date. Credits add, debits subtract (because wallet accounts are credit-normal liabilities).

curl "https://api.shiwake.example.com/api/v1/banking/wallets/wal_01HZ.../statement?from=2026-03-01&to=2026-03-31" \
  -H "X-Api-Key: sk_live_..."

Statement line fields

Prop

Type


Tenant summary

GET/api/v1/banking/reports/summary?from=2026-03-01&to=2026-03-31&currency=GHS

Aggregated report for the current tenant: transaction volumes, fee revenue, channel breakdown, and wallet counts by product.

Query parameters

Prop

Type

{
  "code": 200,
  "data": {
    "from": "2026-03-01",
    "to": "2026-03-31",
    "currency": "GHS",
    "totalDeposits": 50000000,
    "depositCount": 420,
    "totalWithdrawals": 15000000,
    "withdrawalCount": 150,
    "totalTransfers": 8000000,
    "transferCount": 200,
    "totalFeesCollected": 750000,
    "netFlow": 35000000,
    "channelBreakdown": [
      {
        "channel": "paystack",
        "depositTotal": 30000000,
        "depositCount": 250,
        "withdrawalTotal": 10000000,
        "withdrawalCount": 100
      },
      {
        "channel": "momo",
        "depositTotal": 20000000,
        "depositCount": 170,
        "withdrawalTotal": 5000000,
        "withdrawalCount": 50
      }
    ],
    "walletCounts": [
      {
        "productName": "Savings Account",
        "productCode": "SAVINGS",
        "activeCount": 1250,
        "frozenCount": 12,
        "closedCount": 45
      }
    ]
  }
}

Platform summary

GET/api/v1/platform/reports/summary?from=2026-03-01&to=2026-03-31

This endpoint requires platform-admin authentication (JWT with platform-admin role), not a tenant API key.

Cross-tenant summary for platform operators. Iterates all tenants and returns transaction volume, fee revenue, and wallet counts per tenant.

Query parameters

Prop

Type

{
  "code": 200,
  "data": {
    "from": "2026-03-01",
    "to": "2026-03-31",
    "tenants": [
      {
        "tenantId": "ten_01HZ...",
        "tenantName": "Acme Fintech",
        "totalTransactionVolume": 65000000,
        "transactionCount": 570,
        "totalFeeRevenue": 750000,
        "activeWalletCount": 1250
      },
      {
        "tenantId": "ten_02HZ...",
        "tenantName": "BetaPay",
        "totalTransactionVolume": 30000000,
        "transactionCount": 280,
        "totalFeeRevenue": 350000,
        "activeWalletCount": 600
      }
    ],
    "totalVolume": 95000000,
    "totalFees": 1100000,
    "totalActiveWallets": 1850
  }
}
Edit on GitHub

Last updated on

On this page