KashierDevelopersKashier Developers
API reference and playgroundBalance and accounts

Get balance account overview

curl -X GET "https://test-api.kashier.io/v2/account/overview/string"
{  "message": "string",  "data": {    "_id": "string",    "accountId": "string",    "accountName": "string",    "merchantId": "string",    "merchantName": "string",    "totalBalance": 0,    "availableBalance": 0,    "allowedNegativeBalance": 0,    "isIncludeInBulkTransfer": true,    "lastTransfer": 0,    "totalBalanceBeforeLastTransfer": 0,    "lastTransferDate": "string",    "payoutMethod": {      "method": "string",      "payoutFields": {        "bankName": "string",        "bankBranch": "string",        "accountHolderName": "string",        "accountNumber": "string",        "branchCode": "string"      }    },    "createdAt": "string",    "updatedAt": "string"  }}

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 full account document including its payout method.

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

Path Parameters

accountId*string

Balance account identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/account/overview/{accountId}

List balance accounts GET

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 a…

Get payments overview for an account GET

Summarises the money that came into a balance account over a date range — the settled payments credited to it. Pair it with the payouts overview to see both sides of the account for the same period.