Skip to main content
GET
Check gift card balance

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: write operations, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Read-only access (GET requests only, plus POST semantic search)
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries

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)
  • All write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Query Parameters

code
string
required

The unique gift card code to look up (e.g. GTSA-1B2C-3D4E-5F6G).

fields
string

Comma-separated list of fields to include in the embedded gift_card object.

Allowed Fields:

  • id, code, value, balance, status, type
  • expiry_date, customer_id, issued_to, issued_date, last_used
  • minimum_purchase_amount, maximum_usage_percentage, usage_restrictions
  • redemption_count, max_redemptions, created_at, updated_at

Unknown field names will return a 400 error.

Response

Success

valid
boolean

True when the gift card is active, has balance > 0, and is not expired.

balance
number
status
string

Lifecycle status. A gift card is only redeemable while active.

expiry_date
string<date> | null
maximum_usage_percentage
number | null
gift_card
object