Marketplace
Auth check + org context
Confirms the API key is valid + returns the operator’s org context (name, currency, timezone) and the available cards. First call every POS adapter makes on install.
Requires NO specific scope — any valid (non-revoked, non-expired) key works. Brute-force / rate-limit protection still applies.
GET
https://dashboard.perkstar.co.uk/api/v1
/
marketplace
/
ping
Auth check + org context
curl --request GET \
--url https://dashboard.perkstar.co.uk/api/v1/marketplace/ping \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dashboard.perkstar.co.uk/api/v1/marketplace/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://dashboard.perkstar.co.uk/api/v1/marketplace/ping"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/marketplace/ping",
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;
}{
"data": {
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"currency": "<string>",
"timezone": "<string>",
"default_card_id": "<string>"
},
"api_key": {
"id": "<string>",
"prefix": "<string>",
"name": "<string>",
"scopes": [
"<string>"
],
"mode": "live",
"rate_limit_per_minute": 123
},
"available_cards": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "STAMP"
}
],
"server_time": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}Was this page helpful?
⌘I
Auth check + org context
curl --request GET \
--url https://dashboard.perkstar.co.uk/api/v1/marketplace/ping \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dashboard.perkstar.co.uk/api/v1/marketplace/ping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://dashboard.perkstar.co.uk/api/v1/marketplace/ping"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://dashboard.perkstar.co.uk/api/v1/marketplace/ping",
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;
}{
"data": {
"organization": {
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"currency": "<string>",
"timezone": "<string>",
"default_card_id": "<string>"
},
"api_key": {
"id": "<string>",
"prefix": "<string>",
"name": "<string>",
"scopes": [
"<string>"
],
"mode": "live",
"rate_limit_per_minute": 123
},
"available_cards": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "STAMP"
}
],
"server_time": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}{
"error": {
"type": "authentication_error",
"message": "<string>",
"code": "<string>",
"param": "<string>"
}
}
