Balance Inquiry

The API allows the merchant to check the balance(s) for the different currencies they might hold.

GET https://sandbox-api.govbill.ug/v1/wallet-balances

The endpoint retrieves the balance(s) by currency

Headers

Name	Type	Description
public-key*	String	The Public Key as shared in the approval email
secret-key*	String	The Secret Key as shared in the approval email

200: OK Returns array of wallet balances based on the currency

{
  "code": 200,
  "status": "success",
  "message": "Request completed successfully.",
  "data": {
    "merchant_wallets": [
      {
        "merchant_id": 6,
        "currency": "UGX",
        "balance": 2009768
      }
    ]
  }
}

400: Bad Request When the request isn't formed as expected

{
  "code": 400,
  "status": "error",
  "message": "secret-key is required",
  "data": {}
}

401: Unauthorized When one of the keys is invalid

{
  "code": 401,
  "status": "error",
  "message": "Unauthorized API access. Invalid Merchant Secret Key",
  "data": {}
}