<- Gift Cards API

Gift Cards API

Create gift card

POST

 /v2/gift-cards

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

The resulting gift card has a PENDING state. To activate a gift card so that it can be redeemed for purchases, call CreateGiftCardActivity and create an ACTIVATE activity with the initial balance. Alternatively, you can use RefundPayment to refund a payment to the new gift card.

Permissions:GIFTCARDS_WRITE

Guide

Sell gift cards

Try in API Explorer
Link to section

Request body

Example code

Link to section

idempotency_key

string

Required

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Min Length
1
Max Length
128
Link to section

location_id

string

Required

The ID of the location where the gift card should be registered for reporting purposes. Gift cards can be redeemed at any of the seller's locations.

Min Length
1
Link to section

gift_card

Required

The gift card to create. The type field is required for this request. The gan_source and gan fields are included as follows:

To direct Square to generate a 16-digit GAN, omit gan_source and gan.

To provide a custom GAN, include gan_source and gan.

  • For gan_source, specify OTHER.
  • For gan, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be unique for the seller and cannot start with the same bank identification number (BIN) as major credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly increase the risk of fraud. It is the responsibility of the developer to ensure the security of their custom GANs. For more information, see Custom GANs.

To register an unused, physical gift card that the seller previously ordered from Square, include gan and provide the GAN that is printed on the gift card.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

gift_card

The new gift card.

Error descriptions