Skip to main content
GET
List cash locations

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Query Parameters

provider
string
required

Cash provider configuration to query.

latitude
number<double>
required

Search-center latitude in decimal degrees.

longitude
number<double>
required

Search-center longitude in decimal degrees.

radius
number<double>

Search radius around the given coordinates in miles. Must be greater than 0 and at most 100.

Required range: 0 < x <= 100
limit
integer<int32>

Page size, supported range 1-100. The default and maximum are per-resource (see each endpoint's description; most endpoints default to 50) and are resolved at runtime from configuration. Values outside the range are clamped to the nearest bound rather than rejected. The range is published machine-readably via the x-minimum/x-maximum OpenAPI extensions below — deliberately NOT via @minValue/@maxValue, which emit JSON-Schema minimum/maximum and make the generated SDK (Zod) reject values the server accepts and clamps. See PaginatedList.limit for the effective value applied.

startingAfter
string
endingBefore
string
flow
enum<string>

Flow type: determines which provider config to use. Direction of a cash flow. cash_in moves cash to crypto; cash_out moves crypto to cash.

Available options:
cash_in,
cash_out
customerId
string

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.

Response

The request has succeeded.

Cash locations in range, nearest first.

object
string

Resource type discriminator.

limit
integer<int32>

The effective page size applied to this response, after clamping an out-of-range or unset requested limit into the supported bound.

hasMore
boolean

True when more rows exist beyond this page in the direction of travel (forward by default, backward when endingBefore was supplied).

nextCursor
string

Opaque cursor for the next page. Present when another page can be requested; pass it as startingAfter. hasMore=false signals no more pages forward.

previousCursor
string

Opaque cursor pointing at the first item in this page. Present when data is non-empty, except on a list documented as forward only. Pass as endingBefore to page backward; when this yields an empty response the client is at the start of the list.

data
object[]

The page of results.