---
title: "Read the prepaid wallet balance"
method: GET
path: "/api/v1/wallet"
tags: ["wallet"]
---

# Read the prepaid wallet balance

`GET /api/v1/wallet`

## Request

- Base URL: `https://app.blueticked.com`
- URL: `https://app.blueticked.com/api/v1/wallet`
- Auth: HTTP bearer

Read the organization's prepaid wallet balance in ZAR cents and in credits.

Balance is returned in both denominations: `balance_zar_cents` (the money contract) and `balance_credits` (whole credits, rounded down).

`credit_zar_cents` is the fixed conversion rate (1 credit = 5 ZAR cents), so `balance_credits = floor(balance_zar_cents / credit_zar_cents)`.

`enforced` reports whether sends are metered against the wallet; when false, sends are neither blocked nor debited.

Reads require the `wallet:read` scope. Top-ups and balance changes are dashboard-only.

## Response `200`

Success

- object
  - `plan_credit_zar_cents` number, required
  - `plan_credits` number, required
  - `total_zar_cents` number, required
  - `total_credits` number, required
  - `currency` 'ZAR', required
  - `balance_zar_cents` number, required
  - `balance_credits` number, required
  - `credit_zar_cents` number, required
  - `low_threshold_zar_cents` number, nullable, required
  - `enforced` boolean, required
  - `request_id` string, required

## Other responses

- `400`: Validation failed
- `401`: Unauthorized: missing or invalid API key
- `402`: Insufficient wallet balance
- `403`: Forbidden: scope, plan limit, or suspension
- `404`: Not found
- `409`: Conflict (idempotency-key reuse or resource in use)
- `422`: Understood but refused: the request is well-formed, the action is not permitted for this resource
- `429`: Rate limited
- `500`: Internal error
- `502`: An upstream provider refused or failed the request
- `503`: Channel or send queue unavailable

---

[API](https://skmtc.dev/blueticked/apis/blueticked-api.md) · [All operations](https://skmtc.dev/blueticked/apis/blueticked-api/llms.txt) · [OpenAPI document](https://skmtc.dev/blueticked/apis/blueticked-api/revisions/07132284f4ff?raw)
