Retrieve your business wallet balances. Use the optional currency query parameter to retrieve a single currency balance.

-H "x-api-key: your_secret_key"

GET {{host}}/v1/wallets/balance?currency=GHS

Query Parameters

Field	Data Type	Required	Description
currency	string	No	Currency code to filter by, for example `NGN`, `GHS`, or `KES`.

When currency is supplied, Kyshi returns one balance object.

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {
    "currency": "GHS",
    "totalBalance": 10000,
    "availableBalance": 7500,
    "pendingSettlementBalance": 2500,
    "reservedBalance": 0,
    "paidOutBalance": 1200,
    "transferableBalance": 7500
  }
}

Without currency, Kyshi returns balances for all available currencies.

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {
    "balances": [
      {
        "currency": "NGN",
        "totalBalance": 10000,
        "availableBalance": 7500,
        "pendingSettlementBalance": 2500,
        "reservedBalance": 0,
        "paidOutBalance": 1200,
        "transferableBalance": 7500
      }
    ]
  }
}