> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dollarpe.xyz/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.

<Prompt description="List Wallets" actions={["cursor"]}>
  Integrate the Zapyd List Wallets endpoint into my application.

  Endpoint: GET /customer/wallet/list
  Base URL: [https://sandbox.zapyd.com/cms/api/v1](https://sandbox.zapyd.com/cms/api/v1) (sandbox) | [https://api.zapyd.com/cms/api/v1](https://api.zapyd.com/cms/api/v1) (production)
  Full URL (sandbox): GET [https://sandbox.zapyd.com/cms/api/v1/customer/wallet/list](https://sandbox.zapyd.com/cms/api/v1/customer/wallet/list)

  Auth headers required on every request:

  * X-API-KEY: your API key
  * X-TIMESTAMP: current Unix time in seconds
  * X-SIGNATURE: Base64(HMAC-SHA256(key=apiSecret, data=X-API-KEY + "|" + X-TIMESTAMP + "|" + canonicalBody))
    canonicalBody = request JSON with keys sorted at every nesting level, no whitespace (separators "," and ":"), non-ASCII escaped as lowercase \uXXXX. GET requests always sign "{}" (query params are not signed). Send the exact canonicalBody string as the request body. Timestamp must be within 300s of server time.

  Task: Write a typed function that:

  1. Accepts optional filters: customer\_id, network, status, start\_date, end\_date, page, page\_size (max 100)
  2. Builds the signed auth headers (GET signs "{}"; query params are not signed)
  3. Calls GET /customer/wallet/list with the filters as query parameters
  4. Returns data.wallets and data.pagination (current\_page, total\_pages, total\_count, page\_size, has\_next, has\_previous)
  5. Handles 400 and 500 errors

  Language: TypeScript
</Prompt>


## 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

````