Cash voucher list
curl --request GET \
--url https://api.atlas.kitchen/admin/v1/cash_vouchers \
--header 'X-Api-Key: <api-key>' \
--header 'X-Merchant-Id: <api-key>'import requests
url = "https://api.atlas.kitchen/admin/v1/cash_vouchers"
headers = {
"X-Api-Key": "<api-key>",
"X-Merchant-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Api-Key': '<api-key>', 'X-Merchant-Id': '<api-key>'}
};
fetch('https://api.atlas.kitchen/admin/v1/cash_vouchers', 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://api.atlas.kitchen/admin/v1/cash_vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Merchant-Id: <api-key>"
],
]);
$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://api.atlas.kitchen/admin/v1/cash_vouchers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Merchant-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.atlas.kitchen/admin/v1/cash_vouchers")
.header("X-Api-Key", "<api-key>")
.header("X-Merchant-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atlas.kitchen/admin/v1/cash_vouchers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Merchant-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "cash_voucher",
"items": [
{
"id": 123,
"label": "External gift voucher",
"description": "Issued by external gift-card platform",
"code": "EXT-ABC123",
"value": 5000,
"expires_after": "2026-12-31",
"unique": true,
"status": "active",
"redemptions_count": 0,
"created_at": 1781615664,
"updated_at": 1781615664
}
]
}{
"type": "<string>",
"message": "<string>",
"error_hash": {}
}Cash voucher list
Lists cash vouchers for the merchant. Use status to filter active, expired, or redeemed vouchers, and code to search by voucher code.
Cash voucher values are monetary amounts in minor currency units (cents). For example, 5000 means $50.00.
Redemption happens through the existing POS cash voucher flow. This endpoint does not register redemption webhooks.
GET
/
cash_vouchers
Cash voucher list
curl --request GET \
--url https://api.atlas.kitchen/admin/v1/cash_vouchers \
--header 'X-Api-Key: <api-key>' \
--header 'X-Merchant-Id: <api-key>'import requests
url = "https://api.atlas.kitchen/admin/v1/cash_vouchers"
headers = {
"X-Api-Key": "<api-key>",
"X-Merchant-Id": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Api-Key': '<api-key>', 'X-Merchant-Id': '<api-key>'}
};
fetch('https://api.atlas.kitchen/admin/v1/cash_vouchers', 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://api.atlas.kitchen/admin/v1/cash_vouchers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Merchant-Id: <api-key>"
],
]);
$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://api.atlas.kitchen/admin/v1/cash_vouchers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("X-Merchant-Id", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.atlas.kitchen/admin/v1/cash_vouchers")
.header("X-Api-Key", "<api-key>")
.header("X-Merchant-Id", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.atlas.kitchen/admin/v1/cash_vouchers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'
request["X-Merchant-Id"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"object": "cash_voucher",
"items": [
{
"id": 123,
"label": "External gift voucher",
"description": "Issued by external gift-card platform",
"code": "EXT-ABC123",
"value": 5000,
"expires_after": "2026-12-31",
"unique": true,
"status": "active",
"redemptions_count": 0,
"created_at": 1781615664,
"updated_at": 1781615664
}
]
}{
"type": "<string>",
"message": "<string>",
"error_hash": {}
}Authorizations
Your API key provided during onboarding. Example c2fb5ae6ea99c37d...
Your numeric merchant ID. Example 1
Query Parameters
Filter by voucher status.
Available options:
active, expired, redeemed Partial, case-insensitive voucher code search.
Was this page helpful?
⌘I