> **Source:** https://knowledge.leegality.com/document-execution/api/list-wallet-purchases > **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/list — List eSign purchases Returns consumption and expiry details of eSign purchases made from your account. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` GET https://app1.leegality.com/api/v3.0/wallet/balance/list?completed={completed}&max={max}&offset={offset} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.0/wallet/balance/list` - Sandbox: `https://sandbox.leegality.com/api/v3.0/wallet/balance/list` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `completed` | query | No | boolean | Filter by purchase consumption status. When `true`, returns only purchases that are fully consumed (no remaining credits). When `false` or omitted, returns purchases that still have eSign credits remaining. **Default:** `false` | — | | `max` | query | No | integer | Maximum number of records to return. **Default:** `20` **Maximum:** `40` | — | | `offset` | query | No | integer | Number of records to skip before returning results. Use with `max` for pagination. **Default:** `0` | — | --- ## Responses ### 200 — eSign purchase list retrieved successfully. Response wrapper for the List eSign Purchases API. On success (`status: 1`), `data.balances` contains the array of purchase entries. 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` | WalletPurchaseListData | No | Contains the list of eSign purchase entries. See **WalletPurchaseListData** 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.` | #### WalletPurchaseListData Contains the list of eSign purchase entries. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `balances` | array\ | No | Array of eSign purchase entries, sorted by purchase date (oldest first). See **WalletPurchaseItem** below. | — | ##### WalletPurchaseItem Details of a single eSign purchase. **Purchase math:** `purchaseQuantity` = `consumed` + `unused` + `expired`. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `consumed` | number | No | Number of eSign credits consumed from this purchase. | `420` | | `expired` | number | No | Number of eSign credits that have expired from this purchase. | `0` | | `expiryDate` | string | No | Expiry date and time of this purchase. **Format:** `DD-MM-YYYY HH:MM:SS`. | `29-05-2025 16:02:12` | | `purchaseDate` | string | No | Date and time when this purchase was made. **Format:** `DD-MM-YYYY HH:MM:SS`. | `29-05-2024 16:02:12` | | `purchaseQuantity` | number | No | Total number of eSign credits in this purchase. **Formula:** `purchaseQuantity` = `consumed` + `unused` + `expired`. | `435` | | `unused` | number | No | Number of eSign credits still available from this purchase. | `15` | ### Sample Response (200) ```json { "status": 1, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ], "data": { "balances": [ { "consumed": 420, "expired": 0, "expiryDate": "29-05-2025 16:02:12", "purchaseDate": "29-05-2024 16:02:12", "purchaseQuantity": 435, "unused": 15 } ] } } ```