Virtual Accounts

Retrieve wallet balance

Changed on Nov 3, 2026

Returns your available balance. Funds still pending settlement and payouts already reserved are not available to send.

get/v1/wallets/balance

Request

Base URL
https://api.kyshi.co
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/kyshi/apis/kyshi-mor-public-api/docs/v1/wallets/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

currencystring required

Response

Success.

statusboolean required

true on success.

messagestring required

codenumber required

Mirrors the HTTP status code.

Example response

{
  "status": true,
  "message": "Success",
  "code": 200,
  "data": {}
}

Changes

Nov 3, 20264aed77604588 Revision changes
- breaking
  the query request parameter currency became required
- breaking
  removed the enum value GHS from the query request parameter currency
- breaking
  removed the enum value KES from the query request parameter currency
- breaking
  removed the enum value NGN from the query request parameter currency
- breaking
  removed the enum value USD from the query request parameter currency
- breaking
  removed the enum value XOF from the query request parameter currency
- breaking
  removed the enum value ZAR from the query request parameter currency
- breaking
  the response's body type changed from object to no type for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the endpoint scheme security ApiKeyAuth was added to the API
- info
  added subschema #2 to the response body allOf list for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history