ShiwakeDocs
Reports

/banking/reports/ledger-snapshot

One-shot balance snapshot for the current tenant: system-account balances (float / fee-revenue / fee-expense), total MERCHANT payable, unresolved suspense, and the balanced flag: computed in a single pass. Lets an admin overview avoid making one balance call per account.

GET
/api/v1/banking/reports/ledger-snapshot
X-Api-Key<token>

Tenant API key (sk_live_…), minted from the platform console.

In: header

Query Parameters

currency?string

Response Body

application/json

curl -X GET "https://example.com/api/v1/banking/reports/ledger-snapshot"
{  "message": "string",  "code": 0,  "data": {    "currency": "string",    "platformFloatMinor": 0,    "feeRevenueMinor": 0,    "feeExpenseMinor": 0,    "totalMerchantPayableMinor": 0,    "merchantAccountCount": 0,    "unresolvedSuspenseCount": 0,    "unresolvedSuspenseMinor": 0,    "isBalanced": true  }}
Edit on GitHub

Last updated on