KashierDevelopersKashier Developers
API reference and playgroundBalance and accounts

List balance accounts

curl -X GET "https://test-api.kashier.io/v2/account/overview/accounts-list"
{  "message": "success",  "data": [    {      "_id": "66c4d1f2a3b45c0012ef7a91",      "accountId": "ACC-XXXX-XXX-01",      "merchantId": "YOUR_MID",      "merchantName": "Your store",      "totalBalance": 12500.5,      "availableBalance": 11200,      "allowedNegativeBalance": 0,      "isIncludeInBulkTransfer": false,      "createdAt": "2025-01-01 10:00:00+00:00",      "updatedAt": "2025-06-01 09:15:00+00:00"    }  ],  "pagination": {    "total": 1,    "limit": 20,    "page": 1,    "pages": 1  }}

Lists the balance accounts belonging to the merchant identified by the secret key, with the current balance of each. This is the entry point for the balance overview — take an accountId from here and pass it to the other overview and records reads.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Query Parameters

page?integer

Page number.

limit?integer

Number of records per page.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/account/overview/accounts-list

Export payments for a payment page asynchronously GET

Starts an export of one page's payments in the background and emails the finished file to the account that made the request.

Get balance account overview GET

Retrieves the balance overview of a single account — the headline figures (total balance, available balance) you would show on a dashboard. Use GET /v2/account/{accountId} instead when you need the…