Balance

What the account holds, what it can send and withdraw, and anything on hold.

Every endpoint here needs Authorization: Bearer <token> for a signed-in AutoPayKe account. See Authentication.

Get the balance

GET/api/v1/balance

Bearer token

Amounts are USDC-equivalent minor units (6 decimals). display repeats them in the account's local currency at the current rate, for showing to people.

Request

curl "https://api.autopayke.com/api/v1/balance" \
  -H "Authorization: Bearer $AUTOPAYKE_TOKEN"

Response200 application/json

{
  "ok": true,
  "data": {
    "total": "125400000",
    "availableToSend": "125400000",
    "availableToWithdraw": "100400000",
    "onHold": [
      {
        "amount": "25000000",
        "releaseAt": "2026-11-05T12:00:00.000Z",
        "reason": "card_new_card"
      }
    ],
    "onHoldTotal": "25000000",
    "display": {
      "currency": "KES",
      "rate": "129.10",
      "total": "16189.14",
      "availableToSend": "16189.14",
      "availableToWithdraw": "12961.64",
      "onHoldTotal": "3227.50"
    }
  }
}