curl --request GET \
--url https://sandbox-api.polygon.technology/v0.13/cash-locations \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.polygon.technology/v0.13/cash-locations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.polygon.technology/v0.13/cash-locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/cash-locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.polygon.technology/v0.13/cash-locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.polygon.technology/v0.13/cash-locations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.13/cash-locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"providers": [
{
"provider": "<string>",
"maxTransaction": "<string>",
"maxDailyPerCustomer": "<string>",
"locations": [
{
"id": "<string>",
"object": "cashLocation",
"cashLocationReference": "<string>",
"name": "<string>",
"provider": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"buyAllowed": true,
"sellAllowed": true,
"distance": 123,
"distanceUnit": "<string>",
"hours": "<string>",
"supportedAssets": [
"<string>"
]
}
]
}
]
}{
"error": "InvalidParameter",
"code": 10006,
"msg": "latitude must be between -90 and 90",
"cause": "<string>"
}{
"error": "CustomerNotFound",
"code": 10001,
"msg": "customer not found",
"cause": "<string>"
}{
"error": "Internal",
"code": 10124,
"msg": "internal error",
"cause": "<string>"
}{
"error": "ProviderUnavailable",
"code": 10121,
"msg": "cash location provider is temporarily unavailable",
"cause": "<string>"
}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.
curl --request GET \
--url https://sandbox-api.polygon.technology/v0.13/cash-locations \
--header 'Authorization: Bearer <token>'import requests
url = "https://sandbox-api.polygon.technology/v0.13/cash-locations"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://sandbox-api.polygon.technology/v0.13/cash-locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.13/cash-locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.polygon.technology/v0.13/cash-locations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox-api.polygon.technology/v0.13/cash-locations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.13/cash-locations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"providers": [
{
"provider": "<string>",
"maxTransaction": "<string>",
"maxDailyPerCustomer": "<string>",
"locations": [
{
"id": "<string>",
"object": "cashLocation",
"cashLocationReference": "<string>",
"name": "<string>",
"provider": "<string>",
"address": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"coordinates": {
"latitude": 123,
"longitude": 123
},
"buyAllowed": true,
"sellAllowed": true,
"distance": 123,
"distanceUnit": "<string>",
"hours": "<string>",
"supportedAssets": [
"<string>"
]
}
]
}
]
}{
"error": "InvalidParameter",
"code": 10006,
"msg": "latitude must be between -90 and 90",
"cause": "<string>"
}{
"error": "CustomerNotFound",
"code": 10001,
"msg": "customer not found",
"cause": "<string>"
}{
"error": "Internal",
"code": 10124,
"msg": "internal error",
"cause": "<string>"
}{
"error": "ProviderUnavailable",
"code": 10121,
"msg": "cash location provider is temporarily unavailable",
"cause": "<string>"
}Authorizations
Token from POST /auth/token
Query Parameters
Cash provider configuration to query.
Search-center latitude in decimal degrees.
Search-center longitude in decimal degrees.
Search radius around the given coordinates.
Maximum number of results per page.
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.
cash_in, cash_out 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 grouped by provider.
Providers with locations in range.
Hide child attributes
Hide child attributes
Cash provider.
Maximum single-transaction amount.
Maximum daily total per customer.
Locations for this provider, nearest first.
Hide child attributes
Hide child attributes
Cash-location ID (loc_ prefix). Pass it as cash.locationId when creating a cash-in, or as details.cashLocationId on the cash side of a quote or transaction for a cash payout. The part after the prefix is the provider's own catalog identifier rather than a generated ID (e.g. loc_CVS10804), so treat the whole value as an opaque string.
Resource type discriminator. Always "cashLocation".
cashLocation Provider reference for the location, from GET /cash-locations.
Display name.
Cash provider.
Postal address.
City.
State / province / region.
ZIP / postal code.
ISO 3166-1 alpha-2 country code.
Whether cash-in (buy) is supported at this location.
Whether cash-out (sell) is supported at this location.
Distance from the search coordinates.
Unit for distance (e.g. mi, km).
Opening hours.
Assets supported at this location.
Was this page helpful?