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.

limit
integer<int32>

Maximum number of results per page.

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

200 - application/json

The request has succeeded.

Cash locations grouped by provider.

providers
object[]
required

Providers with locations in range.