Docs menu

Preview: the API is being built and these endpoints may change

GET/api/v1/wallet/balance

Get wallet

Your balance, what is held, and what is available.

Returns the wallet for the mode of the key you call with.

Request

bash
curl https://api.simconnectng.com/api/v1/wallet/balance \
  -H "Authorization: Bearer $SIMCONNECT_KEY"

Response

json
{
  "success": true,
  "data": {
    "id": "0192e1a0-4b7c-7d2e-8f9a-1b2c3d4e5f60",
    "mode": "live",
    "currency": "NGN",
    "balance": 24850.00,
    "held": 12.00,
    "available": 24838.00,
    "low_balance_threshold": 5000.00,
    "updated_at": "2026-10-06T12:04:03Z"
  },
  "message": "OK",
  "code": "OK"
}

held is the fees of sales still on their way. low_balance_threshold is your alert level: when balance drops below it you get a wallet.low_balance webhook. The figures shown here are placeholders.

Error

json
{ "success": false, "data": null, "message": "Invalid API key", "code": "AUTH_REQUIRED" }

Give this to your coding agent

prompt
Read https://simconnectng.com/docs/api/get-wallet.md and implement "Get wallet" (GET /api/v1/wallet/balance) in this project.
Read the API key from the SIMCONNECT_KEY environment variable.
Every response is { success, data, message, code }; on an error data is null (or carries data.errors), so branch on code.
View as markdown