> ## Documentation Index
> Fetch the complete documentation index at: https://www.zinc.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Wallet

> Read your wallet balance and the per-order fee, so you can tell whether an order will clear before you place it.

The pre-flight "can I afford this order?" check. All amounts are integer cents.

`POST /orders` compares `max_price + order_fee_cents` against **`spendable_balance`**, not `balance`. Compare against the same figure here instead of discovering the shortfall as a `402`.

## Which balance to use

| Field               | Meaning                                                                                        |
| ------------------- | ---------------------------------------------------------------------------------------------- |
| `balance`           | The ledger balance, including in-flight Zinc Connect holds.                                    |
| `spendable_balance` | What the order gate actually checks. Excludes those holds.                                     |
| `order_fee_cents`   | Zinc's API fee per order, at your negotiated rate.                                             |
| `billed_by_invoice` | `true` for bulk-deal accounts, which are invoiced monthly and skip the balance check entirely. |

The two balances differ only for [Zinc Connect](/docs/v2/connect) accounts with reservations outstanding.

<Info>
  Under a `zn_test_` key (or `X-Test-Mode`) this reads the sandbox wallet. Sandbox orders never draw it down.
</Info>

Funds are added from the [dashboard](https://app.zinc.com) — see [Ways to Pay](/docs/v2/wallet).


## OpenAPI

````yaml versions/latest.json GET /wallet/me
openapi: 3.1.0
info:
  title: Zinc
  summary: >-
    Zinc lets you search, buy, and return items from top online retailers with a
    single API.
  description: >-
    Search, buy, and return items from top online retailers with a single API.
    Supports AI agent ordering via MPP (HTTP 402) — no account required.
    Supported retailers include 1-800-Flowers, Ace Hardware, Amazon, Amazon DE,
    Barnes & Noble, Best Buy, Chewy, Gap, IBS, Lowe's, Macys, Partstown, and 12
    more. Ships to the US and 2 other countries (DE, IT).
  version: '2026-08-21'
  x-logo:
    url: https://mintlify.s3.us-west-1.amazonaws.com/zinc/logo/light.png
  contact:
    name: Zinc API Support
    email: support@zinc.com
    url: https://zinc.com/docs
  x-guidance: >-
    Zinc lets AI agents buy products from online retailers via a single API. Use
    POST /agent/orders to place an order — no Zinc account needed, payment is
    handled via MPP (HTTP 402 flow). Provide a product URL from a supported
    retailer, a shipping address, and max_price in cents. The API charges
    max_price + $1 API fee upfront and refunds the difference on completion. To
    find products first, the /agent/* data endpoints (search, products/search,
    products/offers, products/details) are MPP-paid at $0.01 per call;
    /agent/search returns orderable URLs to feed straight into /agent/orders.
    GET /retailers lists supported retailers for free (no payment or account).
    Authenticated equivalents (orders, products, managed-accounts) require a
    Bearer token (API key prefixed zn_); those orders are paid from a prefunded
    wallet — GET /wallet/me returns the spendable balance and per-order fee, so
    check it before POST /orders to avoid a 402. Docs: https://zinc.com/docs
    Supported retailers include 1-800-Flowers, Ace Hardware, Amazon, Amazon DE,
    Barnes & Noble, Best Buy, Chewy, Gap, IBS, Lowe's, Macys, Partstown, and 12
    more, shipping to the US and 2 other countries (DE, IT).
  x-supported-retailers:
    - 1-800-Flowers
    - Ace Hardware
    - Amazon
    - Amazon DE
    - Barnes & Noble
    - Best Buy
    - Chewy
    - Gap
    - IBS
    - Lowe's
    - Macys
    - Partstown
    - Pokémon Center
    - Sephora
    - Target
    - The Home Depot
    - TikTok
    - Uniqlo
    - Walmart
    - Wayfair
    - Zinc
    - eBay
    - libraccio
    - zazzle
  x-supported-countries:
    - US
    - DE
    - IT
servers:
  - url: https://api.zinc.com
    description: Production
security:
  - BearerAuth: []
paths:
  /wallet/me:
    get:
      tags:
        - wallet
      summary: Get Wallet
      description: >-
        Get your wallet balance.


        All amounts are integer cents. `balance` is the ledger balance;

        `spendable_balance` is what `POST /orders` actually checks against (the
        two

        differ only for Zinc Connect accounts with in-flight holds). An order
        needs

        `max_price + order_fee_cents` spendable, so compare against that before

        placing one instead of discovering a shortfall as a 402. Bulk-deal
        customers

        (`billed_by_invoice: true`) are invoiced monthly and skip the balance
        check.


        Under a `zn_test_` key (or `X-Test-Mode`) this reads the sandbox wallet,

        which sandbox orders never draw down. Funds are added from the
        dashboard.
      operationId: get_wallet_wallet_me_get
      parameters:
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WalletResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        user_id:
          type: integer
          title: User Id
        balance:
          type: integer
          title: Balance
        wallet_type:
          $ref: '#/components/schemas/WalletType'
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        spendable_balance:
          type: integer
          title: Spendable Balance
          description: >-
            Balance available to spend on orders, in cents. Excludes in-flight
            Connect hold reservations, which transiently inflate `balance`. This
            is the figure the order balance check compares against.
          default: 0
        order_fee_cents:
          type: integer
          title: Order Fee Cents
          description: >-
            Zinc's API fee per order, in cents. An order needs `max_price +
            order_fee_cents` available (plus the notifications add-on when the
            order opts into customer emails).
          default: 0
        billed_by_invoice:
          type: boolean
          title: Billed By Invoice
          description: >-
            True for bulk-deal customers, who are invoiced monthly. Their orders
            skip the wallet balance check entirely, so a low balance does not
            block them.
          default: false
      type: object
      required:
        - id
        - user_id
        - balance
        - wallet_type
        - created_at
        - updated_at
      title: WalletResponse
      description: >-
        Response model for wallet data.


        Beyond the raw balance this carries the two other numbers a client needs
        to

        answer "can I place this order?" without reimplementing the gate in

        ``POST /orders``: the *spendable* balance that gate actually compares

        against, and the per-order API fee it adds on top of ``max_price``. Both
        are

        server-derived on purpose — the fee is env-tunable and the two balances

        differ for Connect accounts, so a client computing either one locally
        would

        drift.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WalletType:
      type: string
      enum:
        - api_consumption
        - purchases
      title: WalletType
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Zinc API key (Bearer zn_...)

````