Check gift card balance
Look up a gift card by code and check its validity, balance, expiry and
maximum-usage rules. Accessible with both publishable (tybrite_pk_*) and
secret (tybrite_sk_*) API keys.
The valid flag is true only when the gift card is active, has a
positive balance, and has not expired.
Responses are cached at the edge for ~30s and support ETag revalidation
via If-None-Match.
curl --request GET \
--url https://api.tybritelabs.com/v1/gift-cards/check \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/gift-cards/check"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/gift-cards/check', 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.tybritelabs.com/v1/gift-cards/check",
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://api.tybritelabs.com/v1/gift-cards/check"
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://api.tybritelabs.com/v1/gift-cards/check")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/gift-cards/check")
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{
"valid": true,
"balance": 100,
"status": "active",
"expiry_date": "2026-03-31",
"maximum_usage_percentage": null,
"gift_card": {
"id": "c91a7918-4a88-440e-8509-993e7ff2cbac",
"code": "GTSA-1B2C-3D4E-5F6G",
"value": 100,
"balance": 100,
"status": "active",
"type": "promotional",
"expiry_date": "2026-03-31",
"customer_id": "a1b2c3d4-5e6f-4abc-9def-000000000abc",
"issued_to": "john.doe@example.com",
"issued_date": "2025-12-17",
"last_used": null,
"minimum_purchase_amount": 0,
"maximum_usage_percentage": null,
"usage_restrictions": {},
"redemption_count": 0,
"max_redemptions": null,
"created_at": "2025-12-17T07:43:31.304672+00:00",
"updated_at": "2026-02-24T08:48:13.548922+00:00"
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}Authorizations
API Key Authentication
Use your API key in the Authorization header:
Authorization: Bearer tybrite_sk_live_YOUR_KEY
Key Types:
Secret Keys (Server-Side Only):
- Format:
tybrite_sk_live_*(production) ortybrite_sk_test_*(sandbox) - Full read/write access to all endpoints
- ⚠️ NEVER expose in client-side code or public repositories
- Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations
Publishable Keys (Client-Safe):
- Format:
tybrite_pk_live_*(production) ortybrite_pk_test_*(sandbox) - Catalogue reads, plus the actions a shopper takes for themselves
- ✅ Safe for client-side JavaScript, mobile apps, and public code
- Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents
Endpoint-Specific Requirements:
- Authentication endpoints (
/v1/auth/*): Secret key required - Payment verification (
POST /v1/payments/verify): Secret key required - AI Recommendations (
POST /v1/recommendations): Secret key required - Semantic Search (
POST /v1/search): Both key types allowed (read-only operation) - Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
- All other write operations: Secret key required
- All read operations: Both key types allowed
Using a publishable key for restricted operations returns 403 Forbidden.
Query Parameters
The unique gift card code to look up (e.g. GTSA-1B2C-3D4E-5F6G).
Comma-separated list of fields to include in the embedded gift_card object.
Allowed Fields:
id,code,value,balance,status,typeexpiry_date,customer_id,issued_to,issued_date,last_usedminimum_purchase_amount,maximum_usage_percentage,usage_restrictionsredemption_count,max_redemptions,created_at,updated_at
Unknown field names will return a 400 error.
curl --request GET \
--url https://api.tybritelabs.com/v1/gift-cards/check \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.tybritelabs.com/v1/gift-cards/check"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.tybritelabs.com/v1/gift-cards/check', 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.tybritelabs.com/v1/gift-cards/check",
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://api.tybritelabs.com/v1/gift-cards/check"
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://api.tybritelabs.com/v1/gift-cards/check")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tybritelabs.com/v1/gift-cards/check")
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{
"valid": true,
"balance": 100,
"status": "active",
"expiry_date": "2026-03-31",
"maximum_usage_percentage": null,
"gift_card": {
"id": "c91a7918-4a88-440e-8509-993e7ff2cbac",
"code": "GTSA-1B2C-3D4E-5F6G",
"value": 100,
"balance": 100,
"status": "active",
"type": "promotional",
"expiry_date": "2026-03-31",
"customer_id": "a1b2c3d4-5e6f-4abc-9def-000000000abc",
"issued_to": "john.doe@example.com",
"issued_date": "2025-12-17",
"last_used": null,
"minimum_purchase_amount": 0,
"maximum_usage_percentage": null,
"usage_restrictions": {},
"redemption_count": 0,
"max_redemptions": null,
"created_at": "2025-12-17T07:43:31.304672+00:00",
"updated_at": "2026-02-24T08:48:13.548922+00:00"
}
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters",
"details": "The 'email' field is required"
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid Authorization header"
}
}{
"error": {
"code": "not_found",
"message": "Resource not found"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests for this API key. Please slow down and try again shortly.",
"remaining": 0,
"reset": 1706198400
}
}{
"error": {
"code": "server_error",
"message": "An unexpected error occurred"
}
}
