---
title: "Wallet balance and recent ledger rows"
method: GET
path: "/api/agent/v1/wallet"
---

# Wallet balance and recent ledger rows

`GET /api/agent/v1/wallet`

## Request

- Base URL: `https://essentras.com`
- URL: `https://essentras.com/api/agent/v1/wallet`
- Auth: HTTP bearer

Requires wallet:read. Ledger amounts are signed: positive is money in, negative is money out.

## Query parameters

- `limit` integer

## Response `200`

The wallet

- object
  - `object` 'wallet'
  - `currency` string
  - `available` number
  - `reserved` number
  - `purchased_balance` number
  - `promotional_balance` number
  - `refundable` number
  - `top_up_url` string, uri
  - `transactions` object[]
    - `id` string
    - `created_at` string, date-time
    - `kind` string
    - `amount` number
    - `status` string
    - `source` string, nullable
    - `order_id` string, nullable
    - `note` string, nullable

## Other responses

- `401`: authentication_required, invalid_api_key, api_key_revoked or api_key_expired
- `403`: insufficient_scope (with required_scope) or ip_not_allowed
- `429`: rate_limited

---

[API](https://skmtc.dev/essentras/apis/essentras-agent-api.md) · [All operations](https://skmtc.dev/essentras/apis/essentras-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/essentras/apis/essentras-agent-api/revisions/17a4d739e1b1?raw)