square-engagement

Use when working with Square Loyalty programs, Gift Cards, or Bookings/Appointments. Also use when implementing reward points, gift card lifecycle management, or appointment scheduling with the Square API.

Model	Source
sonnet	pack: payments

Overview

Square engagement APIs cover three domains: Loyalty (points + rewards), Gift Cards (balance lifecycle), and Bookings (appointment scheduling). API version: 2026-01-22.

Full Reference

┏━ 🔧 square-engagement ━━━━━━━━━━━━━━━━━━━━━━━━━┓ ┃ Use when working with Square Loyalty programs,… ┃ ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

Square Engagement APIs

Overview

Square engagement APIs cover three domains: Loyalty (points + rewards), Gift Cards (balance lifecycle), and Bookings (appointment scheduling). API version: 2026-01-22.

Quick Reference

Domain	Base Path	Required OAuth Scope
Loyalty	/v2/loyalty	LOYALTY_READ / LOYALTY_WRITE
Gift Cards	/v2/gift-cards	GIFTCARDS_READ / GIFTCARDS_WRITE
Bookings (buyer)	/v2/bookings	APPOINTMENTS_READ / APPOINTMENTS_WRITE
Bookings (seller)	/v2/bookings	APPOINTMENTS_ALL_READ / APPOINTMENTS_ALL_WRITE

Reference Index

Topic	File
SDK setup, client init, OAuth scopes	reference/authentication.md
Program structure, accounts, points, rewards, events, promotions	reference/loyalty.md
Gift card object, create/activate, activities, compliance limits	reference/gift-cards.md
Availability search, create/update/cancel, profiles, custom attributes	reference/bookings.md
Webhook events for all three domains	reference/webhooks.md
Error codes and handling patterns	reference/error-handling.md
Sandbox setup and domain-specific notes	reference/sandbox-testing.md

Usage: Read the reference file matching your current task from the index above. Each file is self-contained with code examples and inline gotchas.