Tillo · Schema

Tillo Gift Card

Schema for an issued Tillo gift card

FinanceGift CardsPaymentsRewardsIncentives

Properties

Name	Type	Description
client_request_id	string	Client idempotency key
tillo_order_id	string	Tillo internal order ID
status	string
brand	string	Brand identifier slug
face_value	number	Gift card value
currency	string	ISO 4217 currency code
code	string	Redemption code
pin	string	PIN if applicable
barcode	string	Barcode value
redemption_url	string	Digital redemption URL
expiry_date	string	Card expiry date

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tillo/main/json-schema/tillo-gift-card-schema.json",
  "title": "Tillo Gift Card",
  "description": "Schema for an issued Tillo gift card",
  "type": "object",
  "properties": {
    "client_request_id": {"type": "string", "description": "Client idempotency key"},
    "tillo_order_id": {"type": "string", "description": "Tillo internal order ID"},
    "status": {"type": "string", "enum": ["success", "pending", "error", "cancelled"]},
    "brand": {"type": "string", "description": "Brand identifier slug"},
    "face_value": {"type": "number", "minimum": 0, "description": "Gift card value"},
    "currency": {"type": "string", "description": "ISO 4217 currency code"},
    "code": {"type": "string", "description": "Redemption code"},
    "pin": {"type": "string", "description": "PIN if applicable"},
    "barcode": {"type": "string", "description": "Barcode value"},
    "redemption_url": {"type": "string", "format": "uri", "description": "Digital redemption URL"},
    "expiry_date": {"type": "string", "description": "Card expiry date"}
  },
  "required": ["client_request_id", "status"]
}