---
title: "Get balance"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.cardzone.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get balance

Path: Cardzone B2B API › Account

`GET /api/b2b/v1/balance`

Requires an active API credential with the `wallet:read` permission.

## Authentication

- `BearerAuth`, http, header `Authorization`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://cardzone.ai/api/b2b/v1/balance \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://cardzone.ai/api/b2b/v1/balance';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://cardzone.ai/api/b2b/v1/balance"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Current store wallet balance

#### Example

```json
{
  "balance": "1250.00",
  "currency": "SAR"
}
```

- `balance` (`getBalance.response.200.balance`; string, required)
  - example `"123.45"`
- `currency` (`getBalance.response.200.currency`; string, required)
  - example `"SAR"`

### 401

Missing, revoked, or unknown API key. A live key also gets this while its store is inactive, or until the store's business verification is approved and its primary user's email is verified.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "product_status": "out_of_stock"
  }
}
```

- `error` (`getBalance.response.401.error`; object, required)
  - `code` (`getBalance.response.401.error.code`; string, required)
  - `message` (`getBalance.response.401.error.message`; string, required)
  - `details` (`getBalance.response.401.error.details`; unknown, optional) — Optional field-level validation details
  - `product_status` (`getBalance.response.401.error.product_status`; string, optional) — Present on `404` product errors when the product exists but cannot be ordered: `out_of_stock` or `unavailable`, with the same meaning as the catalog `status`. Absent when the product id is unknown or deleted.
    - one of `"out_of_stock"`, `"unavailable"`

### 403

The API credential is valid but does not include the required permission.

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "product_status": "out_of_stock"
  }
}
```

- `error` (`getBalance.response.403.error`; object, required)
  - `code` (`getBalance.response.403.error.code`; string, required)
  - `message` (`getBalance.response.403.error.message`; string, required)
  - `details` (`getBalance.response.403.error.details`; unknown, optional) — Optional field-level validation details
  - `product_status` (`getBalance.response.403.error.product_status`; string, optional) — Present on `404` product errors when the product exists but cannot be ordered: `out_of_stock` or `unavailable`, with the same meaning as the catalog `status`. Absent when the product id is unknown or deleted.
    - one of `"out_of_stock"`, `"unavailable"`


Source: https://docs.cardzone.ai/reference/balance/retrieve/index.md