<- Gift Cards API

Gift Cards API

Retrieve gift card from GAN

POST

 /v2/gift-cards/from-gan

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

Permissions:GIFTCARDS_READ
Try in API Explorer
Link to section

Request body

Example code

Link to section

gan

string

Required

The gift card account number (GAN) of the gift card to retrieve. The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported. Square-issued gift cards have 16-digit GANs.

Min Length
1
Max Length
255
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

gift_card

A gift card that was fetched, if present. It returns empty if an error occurred.

Show attributes