ShiwakeDocs
Reports

/banking/reports/summary

Aggregated report for the current tenant: deposit/withdrawal totals, transfer volume, fees collected, channel breakdown, and wallet counts by product.

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

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

In: header

Query Parameters

from?string
Formatdate-time
to?string
Formatdate-time
currency?string

Response Body

application/json

curl -X GET "https://example.com/api/v1/banking/reports/summary"
{  "message": "string",  "code": 0,  "data": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "currency": "string",    "totalDeposits": 0,    "depositCount": 0,    "totalWithdrawals": 0,    "withdrawalCount": 0,    "totalTransfers": 0,    "transferCount": 0,    "totalFeesCollected": 0,    "netFlow": 0,    "channelBreakdown": [      {        "channel": "string",        "depositTotal": 0,        "depositCount": 0,        "withdrawalTotal": 0,        "withdrawalCount": 0      }    ],    "walletCounts": [      {        "productName": "string",        "productCode": "string",        "activeCount": 0,        "frozenCount": 0,        "closedCount": 0      }    ]  }}
Edit on GitHub

Last updated on