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

# List cash locations

> Returns cash pickup and deposit locations for the given provider within
range of the supplied coordinates, each with its distance from that point.
Use the flow parameter to select the cash-in or cash-out provider
configuration.



## OpenAPI

````yaml /api-reference/openapi.yaml get /cash-locations
openapi: 3.0.3
info:
  title: Polygon OMS Public API
  version: v26.05.28-0001
  description: >-
    Unified API for moving money between crypto and fiat. Three ways to move
    money: Transactions (instant, wallet or card funded, including Cash-In for
    in-person cash deposits), Deposit Addresses (reusable crypto deposit
    configurations), and Virtual Accounts (dedicated bank accounts that
    auto-convert fiat to crypto). Standard transactions follow a two-step flow:
    create a Quote (pricing), then create a Transaction (execution). Cash-in
    codes generate a one-time deposit code for in-person cash deposits at retail
    locations.
  contact:
    name: Polygon OMS
    url: https://oms.polygon.technology
servers:
  - url: https://sandbox-api.polygon.technology/v0.13
    description: Sandbox
  - url: https://api.polygon.technology/v0.13
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Auth
    description: Authentication via FrontEgg
  - name: Customers
    description: Customer management and KYC
  - name: Customer
  - name: Wallet
  - name: Quote
  - name: Transaction
  - name: CashIns
  - name: CashLocation
  - name: Sandbox
  - name: VirtualAccount
  - name: Counterparty
  - name: ExternalAccount
  - name: Reference
  - name: DepositAddress
paths:
  /cash-locations:
    get:
      tags:
        - CashLocation
      summary: List cash locations
      description: >-
        Returns cash pickup and deposit locations for the given provider within

        range of the supplied coordinates, each with its distance from that
        point.

        Use the flow parameter to select the cash-in or cash-out provider

        configuration.
      operationId: listCashLocations
      parameters:
        - name: provider
          in: query
          required: true
          description: Cash provider configuration to query.
          schema:
            type: string
        - name: latitude
          in: query
          required: true
          description: Search-center latitude in decimal degrees.
          schema:
            type: number
            format: double
        - name: longitude
          in: query
          required: true
          description: Search-center longitude in decimal degrees.
          schema:
            type: number
            format: double
        - name: radius
          in: query
          required: false
          description: Search radius around the given coordinates.
          schema:
            type: number
            format: double
        - name: limit
          in: query
          required: false
          description: Maximum number of results per page.
          schema:
            type: integer
            format: int32
        - name: flow
          in: query
          required: false
          description: 'Flow type: determines which provider config to use.'
          schema:
            $ref: '#/components/schemas/CashFlow'
        - name: customerId
          in: query
          required: false
          description: >-
            Optional customer id. When supplied, results are filtered to
            locations

            the customer is eligible to use (matching their KYC country and, for
            US

            customers, their registered state), so ineligible locations are
            never

            offered. Omit to return all locations in range unfiltered.
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashLocationsResponse'
components:
  schemas:
    CashFlow:
      type: string
      enum:
        - cash_in
        - cash_out
      description: >-
        Direction of a cash flow. cash_in moves cash to crypto; cash_out moves
        crypto to cash.
    CashLocationsResponse:
      type: object
      required:
        - providers
      properties:
        providers:
          type: array
          items:
            $ref: '#/components/schemas/CashProvider'
          description: Providers with locations in range.
      description: Cash locations grouped by provider.
    CashProvider:
      type: object
      required:
        - provider
        - maxTransaction
        - maxDailyPerCustomer
        - locations
      properties:
        provider:
          type: string
          description: Cash provider.
        maxTransaction:
          type: string
          description: Maximum single-transaction amount.
        maxDailyPerCustomer:
          type: string
          description: Maximum daily total per customer.
        locations:
          type: array
          items:
            $ref: '#/components/schemas/CashLocation'
          description: Locations for this provider, nearest first.
      description: >-
        A cash provider and its nearby locations, with per-transaction and
        per-customer daily limits.
    CashLocation:
      type: object
      required:
        - id
        - object
        - cashLocationReference
        - name
        - provider
        - address
        - city
        - state
        - zipCode
        - country
        - coordinates
        - buyAllowed
        - sellAllowed
      properties:
        id:
          type: string
          description: >-
            Resource id: `loc_` + the raw provider location id (e.g.
            `loc_CVS10804`).

            This is a deliberate carveout from the TypeID policy — a cash
            location is a

            provider-catalog entry with no BPN DB row, so the id is a prefixed

            provider-internal identifier, not a generated TypeID, and `loc_` is
            not a

            `database/id.go` prefix. The value is unchanged from v0.10 (only
            renamed

            from `locId`).
        object:
          type: string
          enum:
            - cashLocation
          description: Resource type discriminator. Always "cashLocation".
        cashLocationReference:
          type: string
          description: Provider reference for the location, from `GET /cash-locations`.
        name:
          type: string
          description: Display name.
        provider:
          type: string
          description: Cash provider.
        address:
          type: string
          description: Postal address.
        city:
          type: string
          description: City.
        state:
          type: string
          description: State / province / region.
        zipCode:
          type: string
          description: ZIP / postal code.
        country:
          type: string
          description: ISO 3166-1 alpha-2 country code.
        coordinates:
          $ref: '#/components/schemas/CashLocationCoordinates'
        distance:
          type: number
          format: double
          description: Distance from the search coordinates.
        distanceUnit:
          type: string
          description: Unit for `distance` (e.g. mi, km).
        buyAllowed:
          type: boolean
          description: Whether cash-in (buy) is supported at this location.
        sellAllowed:
          type: boolean
          description: Whether cash-out (sell) is supported at this location.
        hours:
          type: string
          description: Opening hours.
        supportedAssets:
          type: array
          items:
            type: string
          description: Assets supported at this location.
      description: >-
        A retail location where a customer can deposit or pick up cash, with its
        capabilities and distance from the search coordinates.
    CashLocationCoordinates:
      type: object
      required:
        - latitude
        - longitude
      properties:
        latitude:
          type: number
          format: double
          description: Latitude in decimal degrees.
        longitude:
          type: number
          format: double
          description: Longitude in decimal degrees.
      description: Latitude/longitude pair.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token from POST /auth/token

````