> **Source:** https://knowledge.leegality.com/document-execution/api/get-wallet-balance > **Site:** Leegality Knowledge Base — https://knowledge.leegality.com > **About:** Leegality is a document execution platform covering eSigning, stamps, NeSL, workflows, and REST API integration. > **Navigation:** Every article on this site has a plain-text version at `.txt` (this format). To get an index of all articles with their `.txt` links, read: https://knowledge.leegality.com/llms.txt > **AI Guide:** For instructions on how to navigate this knowledge base as an AI agent, read: https://knowledge.leegality.com/ai-readable.txt --- # GET /v3.0/wallet/balance/details — Get wallet balance Returns the eSign wallet balance for your account. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.0/wallet/balance/details ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.0/wallet/balance/details` - Sandbox: `https://sandbox.leegality.com/api/v3.0/wallet/balance/details` --- ## Responses ### 200 — Wallet balance retrieved successfully. Response wrapper for the Get Wallet Balance API. On success (`status: 1`), `data` contains the wallet balance breakdown. The `messages` array is empty on success. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `status` | integer | No | API response status. `1` = success, `0` = failure. Allowed: `0`, `1`. | `1` | | `messages` | array\ | No | Array of response messages. Empty array `[]` on success. See **Message** below. | — | | `data` | WalletBalanceData | No | eSign wallet balance breakdown. **Balance math:** `total` = `expired` + `consumed` + `unused` + `reserved`. See **WalletBalanceData** below. | — | #### Message Message object containing a machine-readable code and a human-readable description. Used for success confirmations, errors, and warnings. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `code` | string | No | Response message code. | `simpleWorkFlow.success` | | `message` | string | No | Human-readable success or error message. | `Invitations sent successfully.` | #### WalletBalanceData eSign wallet balance breakdown. **Balance math:** `total` = `expired` + `consumed` + `unused` + `reserved`. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `expired` | number | No | Number of eSign credits that have expired. | `0` | | `reserved` | number | No | Number of eSign credits currently reserved for in-progress documents. | `651` | | `unused` | number | No | Number of eSign credits available for use. | `13194` | | `consumed` | number | No | Number of eSign credits that have been consumed. | `4190` | | `total` | number | No | Total number of eSign credits in the account. **Formula:** `total` = `expired` + `consumed` + `unused` + `reserved`. | `18035` | ### Sample Response (200) ```json { "status": 1, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "expired": 0, "reserved": 651, "unused": 13194, "consumed": 4190, "total": 18035 } } ```