Account Balance¶

Description¶

Returns your merchant wallet balance.

Auth¶

Bearer token required.

Endpoint & Method¶

GET /merchants/wallets/

Parameters¶

None.

Example Request¶

curl -X GET "https://api.cloudpay365.com/api/v1/merchants/wallets/" \
  -H "Authorization: Bearer <ACCESS_TOKEN>"

Example Response¶

data is a list of wallets, not a single object — a merchant can hold more than one wallet (e.g. per currency or sub-account).

{
  "success": true,
  "data": [
    {
      "name": "<MERCHANT_NAME>",
      "account_number": "<YOUR_MERCHANT_ID>",
      "currency_code": "KES",
      "balance": "0.00",
      "locked_balance": "0.00",
      "status": "active"
    }
  ]
}

Note balance and locked_balance are returned as strings, not numbers — parse them explicitly rather than assuming a JSON number type. locked_balance likely represents funds reserved by pending transactions, though this isn't documented in the source collection — confirm the exact semantics with Hivemind Payments.

Example error response¶

{
  "success": false,
  "message": "Authentication credentials were not provided."
}

Returned as 401 Unauthorized when the Bearer token is missing, invalid, or expired.

Notes / Gotchas¶

• No query parameters are accepted — the wallet(s) returned correspond to the merchant tied to your access token.
• If you expect exactly one wallet, still code defensively against the array containing zero or multiple entries.