Square API
You are viewing an old version of the API
Gift Cards
Square API
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.
Guides: Gift Cards Webhooks
-
List gift cards
GET /v2/gift-cards - Lists all gift cards.
BETA -
Create gift card
POST /v2/gift-cards - Creates a digital gift card or registers a physical plastic gift card.
BETA -
Retrieve gift card from GAN
POST /v2/gift-cards/from-gan - Retrieves a gift card using the gift card account number GAN.
BETA -
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.
BETA -
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.
BETA -
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.
BETA -
Retrieve gift card
GET /v2/gift-cards/{id} - Retrieves a gift card using the gift card ID.
BETA