• Sign In
  • Sign In
  • Home

  • Payments

  • Terminal

  • Orders

  • Subscriptions

  • Invoices

  • Catalog

  • Inventory

  • Customers

  • Loyalty

  • Gift Cards

    • Gift Cards

    • Gift Card Activities

  • Bookings

  • Business

  • Team

  • Financials

  • Online

  • Auth

  • Webhook Subscriptions

  • Objects & Enums

  • Webhook Events

  • Deprecated

  • SDKs

<- Square API

Square API

Gift Cards

Create and access gift cards and link customers to gift cards.

Square gift cards enable sellers to boost sales and attract new customers. Sellers can easily sell, redeem, track, and reload Square gift cards.

Developers can use the Gift Cards API to integrate Square gift cards into third-party applications. In addition, developers can use the Gift Card Activities API to create gift card activities, such as activate a gift card, add funds to a gift card, and redeem a gift card.

  • Endpoints

  • Webhooks

List gift cards

GET/v2/gift-cards

Lists all gift cards.

Create gift card

POST/v2/gift-cards

Creates a digital gift card or registers a physical plastic gift card.

Retrieve gift card from GAN

POST/v2/gift-cards/from-gan

Retrieves a gift card using the gift card account number GAN.

Retrieve gift card from nonce

POST/v2/gift-cards/from-nonce

Retrieves a gift card using a secure payment token that represents the gift card.

Link customer to gift card

POST/v2/gift-cards/{gift_card_id}/link-customer

Links a customer to a gift card, which is also referred to as adding a card on file.

Unlink customer from gift card

POST/v2/gift-cards/{gift_card_id}/unlink-customer

Unlinks a customer from a gift card, which is also referred to as removing a card on file.

Retrieve gift card

GET/v2/gift-cards/{id}

Retrieves a gift card using the gift card ID.

Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Contact support
  • Developer blog
  • Slack community
  • YouTube
  • Twitter
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2023 Square, Inc.

  • Developer terms of service
  • Privacy policy