> ## Documentation Index > Fetch the complete documentation index at: https://docs.zapyd.com/llms.txt > Use this file to discover all available pages before exploring further. # List Wallets > Lists active, labelled wallets (the address book), with filters and pagination. Add the Zapyd "List Wallets" call (`GET /cms/api/v1/customer/wallet/list`) to my backend. Lists active, labelled wallets (the address book), with filters and pagination. * Sandbox: `GET https://sandbox.zapyd.com/cms/api/v1/customer/wallet/list` * Production: `GET https://api.zapyd.com/cms/api/v1/customer/wallet/list` Query parameters: * `customer_id` (string, uuid, optional): Filter by customer. * `network` (string, optional): Filter by network (case-insensitive). * `status` (string, optional): Filter by status. One of: `ACTIVE`, `INACTIVE`. * `start_date` (string, date-time, optional): Created on or after (ISO 8601). * `end_date` (string, date-time, optional): Created on or before (ISO 8601). * `page` (integer, optional): Page number. * `page_size` (integer, optional): Results per page. Success: HTTP 200, `{status: true, message, data}`. `data`: `wallets`, `pagination` (`current_page`, `total_pages`, `total_count`, `page_size`, `has_next`, `has_previous`). Every endpoint can also return 401 `AUTH_*` (signature, timestamp or key: fix, don't retry), and 429 or 5xx (retry with backoff). Rules: * Lists only active wallets saved with a `label`, newest first. `data` has `wallets` and `pagination`. Signing (every request): * Headers: `X-API-KEY`, `X-TIMESTAMP` (Unix seconds, within 300 s of server time; generate per request) and `X-SIGNATURE`. * `X-SIGNATURE` = Base64(HMAC-SHA256(key = API secret, message = apiKey + "|" + timestamp + "|" + canonicalBody)). Base64 of the raw digest, not hex. * canonicalBody: the JSON body with keys sorted at every nesting level, no whitespace (separators `,` and `:`), and every non-ASCII character escaped as lowercase `\uXXXX` (Python `json.dumps(body, sort_keys=True, separators=(",", ":"))`). Requests with no body (GET, DELETE) sign `{}`. Query parameters are not signed. * Send the exact canonicalBody string you signed as the request body, with `Content-Type: application/json`. * Test vector: key `3f1b2c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d`, secret `test-secret-do-not-use`, timestamp `1735689600`. Signing `{}` gives `6sCtVSRQjU9+2/af8gdwUAvY1l6Ii6ENcbRfanPkhY0=`. Body `{"customer_id":"78c99d71-f28f-47a9-8302-93b286efbe0e","amount":100.5,"currency":"INR","meta":{"note":"Café","b":2,"a":1}}` gives `l+DvQrzlKbsOSxSYOdWoWHEehcFRZfDJPKlLDkm2cSI=`. Deliver: 1. A typed `listWallets` function in this codebase's language and HTTP client. Reuse an existing Zapyd client and signer, or write one small shared client. 2. Config from `ZAPYD_API_KEY`, `ZAPYD_API_SECRET` and `ZAPYD_BASE_URL`. The secret stays on the server, never in a browser or app. 3. Return `data`. When `status` is false, throw an error with the HTTP status, `err_code`, `message` and `errors`. Don't show raw errors to end users. 4. Retry only 429 and 5xx: exponential backoff from 1 s, capped at 30 s, at most 5 attempts. 5. Amounts as strings. Types for every field above. 6. Tests: the signer against the test vector, and this call against sandbox. Reference: `https://docs.zapyd.com/api-reference-exchange/endpoint/wallet/list.md` ## OpenAPI ````yaml GET /customer/wallet/list openapi: 3.1.0 info: title: Zapyd API description: API for Zapyd - Customer, Payout, and Webhook services license: name: MIT version: 1.0.0 servers: - url: https://sandbox.zapyd.com/pos/api/v1 description: Payout API Base URL variables: base_url: default: https://sandbox.zapyd.com - url: https://sandbox.zapyd.com/cms/api/v1 description: Customer API Base URL variables: base_url: default: https://sandbox.zapyd.com security: - ApiKeyAuth: [] TimestampAuth: [] SignatureAuth: [] tags: - name: Customer description: Customer related operations x-displayName: Customer x-traitTag: true - name: Payout description: Payout related operations - name: Webhooks description: Webhook related operations - name: Widget description: Hosted buy/sell widget session initialization paths: /customer/wallet/list: get: tags: - Wallet description: >- List the address book: active wallets saved with a label, newest first. Filter by customer, network and creation date. parameters: - name: customer_id in: query required: false description: Filter by customer schema: type: string format: uuid example: c2cf861b-342b-4318-a90e-85cd0312e82f - name: network in: query required: false description: Filter by network (case-insensitive) schema: type: string example: Ethereum - name: status in: query required: false description: Filter by status schema: type: string enum: - ACTIVE - INACTIVE - name: start_date in: query required: false description: Created on or after (ISO 8601) schema: type: string format: date-time - name: end_date in: query required: false description: Created on or before (ISO 8601) schema: type: string format: date-time - name: page in: query required: false description: Page number schema: type: integer minimum: 1 default: 1 - name: page_size in: query required: false description: Results per page schema: type: integer minimum: 1 maximum: 100 default: 10 responses: '200': description: Success content: application/json: schema: type: object properties: status: type: boolean example: true message: type: string example: Wallets listed successfully data: type: object properties: wallets: type: array items: type: object properties: id: type: integer description: >- Wallet ID (integer). Use it in the fetch and delete paths. example: 42 wallet_address: type: string description: Wallet address example: '0x1234567890123456789012345678901234567890' network: type: string description: Canonical network name example: Ethereum enum: - Ethereum - Polygon - Arbitrum - Bsc - Sepolia - Solana - Tron label: type: string description: >- Label shown in the address book. Only labelled wallets are returned by List Wallets. example: Main wallet status: type: string description: Wallet status example: ACTIVE enum: - ACTIVE - INACTIVE is_visible: type: boolean description: True when the wallet has a non-empty label example: true created_at: type: string description: Creation time (ISO 8601) example: '2026-09-30T10:00:00Z' format: date-time pagination: type: object properties: current_page: type: integer example: 1 total_pages: type: integer example: 1 total_count: type: integer example: 1 page_size: type: integer example: 10 has_next: type: boolean example: false has_previous: type: boolean example: false '400': description: Bad Request content: application/json: schema: type: object properties: status: type: boolean example: false message: type: string example: Bad Request data: type: 'null' errors: type: object example: date_range: - Start date must be before end date. err_code: type: string example: UNKNOWN_ERROR '500': description: Internal Server Error content: application/json: schema: type: object properties: status: type: boolean example: false message: type: string example: Internal Server Error data: type: 'null' errors: type: object example: {} err_code: type: string example: SYS_INTERNAL_ERROR servers: - url: https://sandbox.zapyd.com/cms/api/v1 description: Customer API Base URL components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: API Key for authentication TimestampAuth: type: apiKey in: header name: X-TIMESTAMP description: Current timestamp in seconds since epoch SignatureAuth: type: apiKey in: header name: X-SIGNATURE description: HMAC SHA256 signature of the request encoded in Base64 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.